flinkmetricsreceiver

README

FlinkMetrics Receiver

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

Status
Stability	alpha: metrics
Distributions	contrib
Issues
Code coverage
Code Owners	@JonathanWamsley | Seeking more code owners!

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: 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

Note: The receiver type has been renamed from flinkmetrics to flink_metrics. The old name is still accepted but will log a deprecation warning.

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

The full list of settings exposed for this receiver are documented in config.go with detailed sample configurations in testdata/config.yaml. 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

Documentation

Index

• func NewFactory() receiver.Factory
• type Config
  • func (cfg *Config) Validate() error

Functions

func NewFactory

func NewFactory() receiver.Factory

NewFactory creates a new receiver factory

Types

type Config

type Config struct {
	scraperhelper.ControllerConfig `mapstructure:",squash"`
	confighttp.ClientConfig        `mapstructure:",squash"`
	metadata.MetricsBuilderConfig  `mapstructure:",squash"`
}

Config defines the configuration for the various elements of the receiver agent.

func (*Config) Validate

func (cfg *Config) Validate() error

Validate validates the configuration by checking for missing or invalid fields