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
meltano config tap-prometheus set --interactive
meltano config tap-prometheus 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-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
- state
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 config
list
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.
Auth Password (auth.password)
-
Environment variable:
TAP_PROMETHEUS_AUTH_PASSWORD
HTTP basic auth password
Configure this setting directly using the following Meltano command:
meltano config tap-prometheus set auth password [value]
Auth Username (auth.username)
-
Environment variable:
TAP_PROMETHEUS_AUTH_USERNAME
HTTP basic auth username
Configure this setting directly using the following Meltano command:
meltano config tap-prometheus set auth username [value]
Endpoint (endpoint)
-
Environment variable:
TAP_PROMETHEUS_ENDPOINT
The Prometheus API endpoint URL - do not include the obligatory /api/v1 suffix in here, the tap will add this itself
Configure this setting directly using the following Meltano command:
meltano config tap-prometheus set endpoint [value]
Metrics (metrics)
-
Environment variable:
TAP_PROMETHEUS_METRICS
Definition of individual prometheus metric query streams. A sample config to calculate daily online peak by customer and environment:
- name: online_peak
query: sum(sessions_count)
batch: '10000'
step: 120s
labels:
type: object
properties:
customer:
type: string
environment:
type: string
Configure this setting directly using the following Meltano command:
meltano config tap-prometheus set metrics [value]
Start Date (start_date)
-
Environment variable:
TAP_PROMETHEUS_START_DATE
Earliest date from which to start collecting data
Configure this setting directly using the following Meltano command:
meltano config tap-prometheus set start_date [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
channel.