tap-metronome - Meltano Hub

Metronome

tap-metronome (hotgluexyz variant)🥇

Billing infrastructure that helps software companies launch, iterate, and scale their usage-based business models.

The tap-metronome extractor pulls data from Metronome 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:

Installation and configuration

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

meltano add extractor tap-metronome

Configure the tap-metronome settings using

meltano config

:

meltano config tap-metronome set --interactive

Test that extractor settings are valid using

meltano config

:

meltano config tap-metronome 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-metronome 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
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-metronome 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:

auth_token
billing_provider_type
customers
end_date
start_date
window_size

Expand To Show SDK Settings

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-metronome 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.

Auth Token (auth_token)

Environment variable: TAP_METRONOME_AUTH_TOKEN

The token to authenticate against the API service

Configure this setting directly using the following Meltano command:

meltano config tap-metronome set auth_token [value]

Billing Provider Type (billing_provider_type)

Environment variable: TAP_METRONOME_BILLING_PROVIDER_TYPE
Default Value: stripe

The Metronome billing provider type (aws_marketplace, stripe, or netsuite).

Configure this setting directly using the following Meltano command:

meltano config tap-metronome set billing_provider_type [value]

Customers (customers)

Environment variable: TAP_METRONOME_CUSTOMERS

A comma separated list of Metronome customer IDs to fetch usage for. If absent, usage for all customers will be returned.

Configure this setting directly using the following Meltano command:

meltano config tap-metronome set customers [value]

End Date (end_date)

Environment variable: TAP_METRONOME_END_DATE

Date up to when historical data will be extracted.

Configure this setting directly using the following Meltano command:

meltano config tap-metronome set end_date [value]

Start Date (start_date)

Environment variable: TAP_METRONOME_START_DATE

Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.

Configure this setting directly using the following Meltano command:

meltano config tap-metronome set start_date [value]

Window Size (window_size)

Environment variable: TAP_METRONOME_WINDOW_SIZE
Default Value: day

A window_size of "day" or "hour" will return the usage for the specified period segmented into daily or hourly aggregates. A window_size of "none" will return a single usage aggregate for the entirety of the specified period. (hour, day, or none).

Configure this setting directly using the following Meltano command:

meltano config tap-metronome set window_size [value]

Expand To Show SDK Settings

Flattening Enabled (flattening_enabled)

Environment variable: TAP_METRONOME_FLATTENING_ENABLED

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

Configure this setting directly using the following Meltano command:

meltano config tap-metronome set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

Environment variable: TAP_METRONOME_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.

Configure this setting directly using the following Meltano command:

meltano config tap-metronome set flattening_max_depth [value]

Stream Map Config (stream_map_config)

Environment variable: TAP_METRONOME_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-metronome set stream_map_config [value]

Stream Maps (stream_maps)

Environment variable: TAP_METRONOME_STREAM_MAPS

Config object for stream maps capability.

Configure this setting directly using the following Meltano command:

meltano config tap-metronome 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-metronome 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-metronome

Maintenance Status

Repo

https://gitlab.com/hotglue/tap-metronome

Maintainer

Keywords