The tap-prometheus extractor pulls data from Prometheus that can then be sent to a destination using a loader.
Alternate Implementations
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-prometheus extractor to your
project using
:meltano add -
Configure the tap-prometheus
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-prometheus --variant signal-aimeltano config tap-prometheus set --interactivemeltano config tap-prometheus testNext 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-prometheus
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:
- catalog
- discover
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-prometheus 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
with the meltano configlist
subcommand:
meltano config tap-prometheus 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.
Enable SSL (enable_ssl)
-
Environment variable:
TAP_PROMETHEUS_ENABLE_SSL
Can optionally be set to false to explicitly disable TLS verification, else it will be inferred from the schema of the proemtheus_endpoint.
Configure this setting directly using the following Meltano command:
meltano config tap-prometheus set enable_ssl [value]Prometheus Endpoint (prometheus_endpoint)
-
Environment variable:
TAP_PROMETHEUS_PROMETHEUS_ENDPOINT
The Prometheus API endpoint URL.
Configure this setting directly using the following Meltano command:
meltano config tap-prometheus set prometheus_endpoint [value]Queries (queries)
-
Environment variable:
TAP_PROMETHEUS_QUERIES
A mapping of query name and its promql query. For example:
queries:
count_by_job: count(up) by (job)
Configure this setting directly using the following Meltano command:
meltano config tap-prometheus set queries [value]Start Date (start_date)
-
Environment variable:
TAP_PROMETHEUS_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-prometheus set start_date [value]Stream Name (stream_name)
-
Environment variable:
TAP_PROMETHEUS_STREAM_NAME -
Default Value:
prometheus
The name of the stream.
Configure this setting directly using the following Meltano command:
meltano config tap-prometheus set stream_name [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-brightgreen){kind=icon}
