-
Notifications
You must be signed in to change notification settings - Fork 4.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Metricbeat] Add Airflow module in xpack (#26220)
* [Metricbeat] Add Airflow module Airflow module is a lightweight module based on Statsd module. It filters, renames and adds metrics according to mappings defined in the manifest.yml (cherry picked from commit 3d01b5b)
- Loading branch information
Andrea Spacca
authored and
mergify-bot
committed
Jul 1, 2021
1 parent
f23335c
commit 814a048
Showing
26 changed files
with
2,047 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
//// | ||
This file is generated! See scripts/mage/docs_collector.go | ||
//// | ||
|
||
[[metricbeat-module-airflow]] | ||
[role="xpack"] | ||
== Airflow module | ||
|
||
beta[] | ||
|
||
This module collects metrics from | ||
https://airflow.apache.org/docs/apache-airflow/stable/logging-monitoring/metrics.html[Airflow metrics] running a | ||
statsd server where airflow will send metrics to. The default metricset is `statsd`. | ||
|
||
[float] | ||
=== Compatibility | ||
|
||
The Airflow module is tested with Airflow 2.1.0. It should work with version | ||
2.0.0 and later. | ||
|
||
[float] | ||
=== Usage | ||
The Airflow module requires <<metricbeat-module-statsd,Statsd>> to receive Statsd metrics. Refer to the link for instructions about how to use Statsd. | ||
|
||
Add the following lines to your Airflow configuration file e.g. `airflow.cfg` ensuring `statsd_prefix` is left empty and replace `%METRICBEAT_HOST%` with the address metricbeat is running: | ||
|
||
``` | ||
[metrics] | ||
statsd_on = True | ||
statsd_host = %METRICBEAT_HOST% | ||
statsd_port = 8126 | ||
statsd_prefix = | ||
``` | ||
|
||
|
||
[float] | ||
=== Example configuration | ||
|
||
The Airflow module supports the standard configuration options that are described | ||
in <<configuration-metricbeat>>. Here is an example configuration: | ||
|
||
[source,yaml] | ||
---- | ||
metricbeat.modules: | ||
- module: airflow | ||
host: "localhost" | ||
port: "8126" | ||
#ttl: "30s" | ||
metricsets: [ 'statsd' ] | ||
---- | ||
|
||
[float] | ||
=== Metricsets | ||
|
||
The following metricsets are available: | ||
|
||
* <<metricbeat-metricset-airflow-statsd,statsd>> | ||
|
||
include::airflow/statsd.asciidoc[] | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
//// | ||
This file is generated! See scripts/mage/docs_collector.go | ||
//// | ||
|
||
[[metricbeat-metricset-airflow-statsd]] | ||
[role="xpack"] | ||
=== Airflow statsd metricset | ||
|
||
beta[] | ||
|
||
include::../../../../x-pack/metricbeat/module/airflow/statsd/_meta/docs.asciidoc[] | ||
|
||
This is a default metricset. If the host module is unconfigured, this metricset is enabled by default. | ||
|
||
==== Fields | ||
|
||
For a description of each field in the metricset, see the | ||
<<exported-fields-airflow,exported fields>> section. | ||
|
||
Here is an example document generated by this metricset: | ||
|
||
[source,json] | ||
---- | ||
include::../../../../x-pack/metricbeat/module/airflow/statsd/_meta/data.json[] | ||
---- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.