Cloudwatch

tap-cloudwatch (meltanolabs variant)🥇

AWS Application and Infrastructure Monitoring

The tap-cloudwatch extractor pulls data from Cloudwatch that can then be sent to a destination using a loader.

Getting Started

Prerequisites

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

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-cloudwatch extractor to your project using 
    meltano add
     : 
    2. meltano add extractor tap-cloudwatch
  2. Configure the tap-cloudwatch settings using 
    meltano config
     : 
    3. meltano config tap-cloudwatch set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-cloudwatch test

Next steps

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

Capabilities

The current capabilities for tap-cloudwatch 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-cloudwatch 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:

You can also list these settings using 

meltano config
with the list subcommand: 

meltano config tap-cloudwatch 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.

AWS Access Key ID (aws_access_key_id)

  • Environment variable: TAP_CLOUDWATCH_AWS_ACCESS_KEY_ID

The access key for your AWS account.


Configure this setting directly using the following Meltano command:

meltano config tap-cloudwatch set aws_access_key_id [value]

AWS Endpoint URL (aws_endpoint_url)

  • Environment variable: TAP_CLOUDWATCH_AWS_ENDPOINT_URL

The complete URL to use for the constructed client.


Configure this setting directly using the following Meltano command:

meltano config tap-cloudwatch set aws_endpoint_url [value]

AWS Profile (aws_profile)

  • Environment variable: TAP_CLOUDWATCH_AWS_PROFILE

The AWS credentials profile name to use. The profile must be configured and accessible.


Configure this setting directly using the following Meltano command:

meltano config tap-cloudwatch set aws_profile [value]

AWS Region Name (aws_region_name)

  • Environment variable: TAP_CLOUDWATCH_AWS_REGION_NAME

The AWS region name (e.g. us-east-1)


Configure this setting directly using the following Meltano command:

meltano config tap-cloudwatch set aws_region_name [value]

AWS Secret Access Key (aws_secret_access_key)

  • Environment variable: TAP_CLOUDWATCH_AWS_SECRET_ACCESS_KEY

The secret key for your AWS account.


Configure this setting directly using the following Meltano command:

meltano config tap-cloudwatch set aws_secret_access_key [value]

AWS Session Token (aws_session_token)

  • Environment variable: TAP_CLOUDWATCH_AWS_SESSION_TOKEN

The session key for your AWS account. This is only needed when you are using temporary credentials.


Configure this setting directly using the following Meltano command:

meltano config tap-cloudwatch set aws_session_token [value]

Batch Increment S (batch_increment_s)

  • Environment variable: TAP_CLOUDWATCH_BATCH_INCREMENT_S
  • Default Value: 3600

The size of the time window to query by, default 3,600 seconds (i.e. 1 hour). If the result set for a batch is greater than the max limit of 10,000 records then the tap will query the same window again where >= the most recent record received. This means that the same data is potentially being scanned >1 times but < 2 times, depending on the amount the results set went over the 10k max. For example a batch window with 15k records would scan the 15k once, receiving 10k results, then scan ~5k again to get the rest. The net result is the same data was scanned ~1.5 times for that batch. To avoid this you should set the batch window to avoid exceeding the 10k limit.


Configure this setting directly using the following Meltano command:

meltano config tap-cloudwatch set batch_increment_s [value]

End Date (end_date)

  • Environment variable: TAP_CLOUDWATCH_END_DATE

The last record date to sync. This tap uses a 5 minute buffer to allow Cloudwatch logs to arrive in full. If you request data from current time it will automatically adjust your end_date to now - 5 mins.


Configure this setting directly using the following Meltano command:

meltano config tap-cloudwatch set end_date [value]

Log Group Name (log_group_name)

  • Environment variable: TAP_CLOUDWATCH_LOG_GROUP_NAME

The log group on which to perform the query.


Configure this setting directly using the following Meltano command:

meltano config tap-cloudwatch set log_group_name [value]

Query (query)

  • Environment variable: TAP_CLOUDWATCH_QUERY

The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.


Configure this setting directly using the following Meltano command:

meltano config tap-cloudwatch set query [value]

Start Date (start_date)

  • Environment variable: TAP_CLOUDWATCH_START_DATE

The earliest record date to sync


Configure this setting directly using the following Meltano command:

meltano config tap-cloudwatch set start_date [value]
Expand To Show SDK Settings

Batch Compression Format (batch_config.encoding.compression)

  • Environment variable: TAP_CLOUDWATCH_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.


Configure this setting directly using the following Meltano command:

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

Batch Encoding Format (batch_config.encoding.format)

  • Environment variable: TAP_CLOUDWATCH_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.


Configure this setting directly using the following Meltano command:

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

Batch Storage Prefix (batch_config.storage.prefix)

  • Environment variable: TAP_CLOUDWATCH_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.


Configure this setting directly using the following Meltano command:

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

Batch Storage Root (batch_config.storage.root)

  • Environment variable: TAP_CLOUDWATCH_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.


Configure this setting directly using the following Meltano command:

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

Faker Locale (faker_config.locale)

  • Environment variable: TAP_CLOUDWATCH_FAKER_CONFIG_LOCALE

One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization


Configure this setting directly using the following Meltano command:

meltano config tap-cloudwatch set faker_config locale [value]

Faker Seed (faker_config.seed)

  • Environment variable: TAP_CLOUDWATCH_FAKER_CONFIG_SEED

Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator


Configure this setting directly using the following Meltano command:

meltano config tap-cloudwatch set faker_config seed [value]

Enable Schema Flattening (flattening_enabled)

  • Environment variable: TAP_CLOUDWATCH_FLATTENING_ENABLED

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


Configure this setting directly using the following Meltano command:

meltano config tap-cloudwatch set flattening_enabled [value]

Max Flattening Depth (flattening_max_depth)

  • Environment variable: TAP_CLOUDWATCH_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-cloudwatch set flattening_max_depth [value]

User Stream Map Configuration (stream_map_config)

  • Environment variable: TAP_CLOUDWATCH_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-cloudwatch set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_CLOUDWATCH_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-cloudwatch 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-cloudwatch 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-cloudwatch

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/meltanolabs/tap-cloudwatch
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Meltano

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • meltano_sdk