tap-sumologic - Meltano Hub

Sumo Logic

tap-sumologic (widen variant)🥈

Cloud Log Management, Monitoring, SIEM Tools

The tap-sumologic extractor pulls data from Sumo Logic that can then be sent to a destination using a loader.

Alternate Implementations

Split Software
(default)
Widen🥈

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Installation and configuration

Add the tap-sumologic extractor to your project using
```
meltano add
```
:

meltano add extractor tap-sumologic --variant widen

Configure the tap-sumologic settings using

meltano config

:

meltano config tap-sumologic set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-sumologic test

Next steps

Follow the remaining steps of the Getting Started guide:

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-sumologic may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

about
batch
catalog
discover
schema-flattening
state
stream-maps

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-sumologic settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

access_id
access_key
end_date
root_url
start_date
tables
time_zone

Expand To Show SDK Settings

batch_config.encoding.compression
batch_config.encoding.format
batch_config.storage.prefix
batch_config.storage.root
flattening_enabled
flattening_max_depth
stream_map_config
stream_maps

You can also list these settings using

meltano config

with the list subcommand:

meltano config tap-sumologic list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Access ID (access_id)

Environment variable: TAP_SUMOLOGIC_ACCESS_ID

The access id for authenticating against the Sumologic API.

Configure this setting directly using the following Meltano command:

meltano config tap-sumologic set access_id [value]

Access Key (access_key)

Environment variable: TAP_SUMOLOGIC_ACCESS_KEY

The access key for authenticating against the Sumologic API.

Configure this setting directly using the following Meltano command:

meltano config tap-sumologic set access_key [value]

End Date (end_date)

Environment variable: TAP_SUMOLOGIC_END_DATE

The latest record date to sync. Sets the to parameter for all queries. Format: YYYY-MM-DDTHH:mm:ss

Configure this setting directly using the following Meltano command:

meltano config tap-sumologic set end_date [value]

Root URL (root_url)

Environment variable: TAP_SUMOLOGIC_ROOT_URL
Default Value: https://api.sumologic.com/api

The Sumologic endpoint for your deployment.

Configure this setting directly using the following Meltano command:

meltano config tap-sumologic set root_url [value]

Start Date (start_date)

Environment variable: TAP_SUMOLOGIC_START_DATE

The earliest record date to sync. Sets the from parameter for all queries. Format: YYYY-MM-DDTHH:mm:ss

Configure this setting directly using the following Meltano command:

meltano config tap-sumologic set start_date [value]

Tables (tables)

Environment variable: TAP_SUMOLOGIC_TABLES

The list of configs for each table/query/stream.

Configure this setting directly using the following Meltano command:

meltano config tap-sumologic set tables [value]

Time Zone (time_zone)

Environment variable: TAP_SUMOLOGIC_TIME_ZONE
Default Value: UTC

The time zone for the queries. Sets the timeZone parameter for all queries

Configure this setting directly using the following Meltano command:

meltano config tap-sumologic set time_zone [value]

Expand To Show SDK Settings

Batch Config Encoding Compression (batch_config.encoding.compression)

Environment variable: TAP_SUMOLOGIC_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-sumologic set batch_config encoding.compression [value]

Batch Config Encoding Format (batch_config.encoding.format)

Environment variable: TAP_SUMOLOGIC_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-sumologic set batch_config encoding.format [value]

Batch Config Storage Prefix (batch_config.storage.prefix)

Environment variable: TAP_SUMOLOGIC_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-sumologic set batch_config storage.prefix [value]

Batch Config Storage Root (batch_config.storage.root)

Environment variable: TAP_SUMOLOGIC_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.

Configure this setting directly using the following Meltano command:

meltano config tap-sumologic set batch_config storage.root [value]

Flattening Enabled (flattening_enabled)

Environment variable: TAP_SUMOLOGIC_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.

Configure this setting directly using the following Meltano command:

meltano config tap-sumologic set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_SUMOLOGIC_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-sumologic set flattening_max_depth [value]

Stream Map Config (stream_map_config)

Environment variable: TAP_SUMOLOGIC_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.

Configure this setting directly using the following Meltano command:

meltano config tap-sumologic set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_SUMOLOGIC_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.

Configure this setting directly using the following Meltano command:

meltano config tap-sumologic set stream_maps [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-sumologic extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the

#plugins-general

channel.

Install

meltano add extractor tap-sumologic --variant widen

Maintenance Status

Repo

https://github.com/Widen/tap-sumologic

Maintainer

Meltano Stats

Keywords