ob-col/receiver/flinkmetricsreceiver/README.md

FlinkMetrics Receiver

Status
Stability	alpha: metrics
Distributions	contrib, observiq, sumo
Issues
Code Owners	@JonathanWamsley, @djaglowski

This receiver uses Flink's REST API to collect Jobmanager, Taskmanager, Job, Task and Operator metrics.

Prerequisites

This receiver supports Apache Flink versions 1.13.6 and 1.14.4.

By default, authentication is not required. However, Flink recommends using a “side car proxy” that Binds the REST endpoint to the loopback interface and to start a REST proxy that authenticates and forwards the request to Flink.

SSL can be enabled with the following REST endpoint options for external connectivity and have a self signed certificate or be self signed.

Configuration

The following settings are optional:

• endpoint (default: http://localhost:15672): The URL of the node to be monitored.
• collection_interval (default = 10s): This receiver collects metrics on an interval. Valid time units are ns, us (or µs), ms, s, m, h.
• tls (defaults defined here): TLS control. By default insecure settings are rejected and certificate verification is on.
• initial_delay (default = 1s): defines how long this receiver waits before starting.

Example Configuration

receivers:
  flinkmetrics:
    endpoint: http://localhost:8081
    collection_interval: 10s

The full list of settings exposed for this receiver are documented here with detailed sample configurations here. TLS config is documented further under the opentelemetry collector's configtls package.

Metrics

Details about the metrics produced by this receiver can be found in metadata.yaml