Key Default Type Description
metrics.reporter.prometheus.allowList
(none) String The allow-list of metric name. The default is to report all metrics
metrics.reporter.prometheus.deleteOnShutdown
true Boolean Specifies whether to delete metrics from the PushGateway on shutdown. Flink will try its best to delete the metrics but this is not guaranteed. See here for more details.
metrics.reporter.prometheus.filterLabelValueCharacters
true Boolean Specifies whether to filter label value characters. If enabled, all characters not matching [a-zA-Z0-9:_] will be removed, otherwise no characters will be removed. Before disabling this option please ensure that your label values meet the Prometheus requirements.
metrics.reporter.prometheus.groupingKey
(none) String Specifies the grouping key which is the group and global labels of all metrics. The label name and value are separated by '=', and labels are separated by ';', e.g., k1=v1;k2=v2. Please ensure that your grouping key meets the Prometheus requirements.
metrics.reporter.prometheus.hostUrl
(none) String The PushGateway server host URL including scheme, host name, and port.
metrics.reporter.prometheus.jobName
(none) String The job name under which metrics will be pushed
metrics.reporter.prometheus.password
(none) String (Optional) The password for HTTP Basic Authentication with the PushGateway.
metrics.reporter.prometheus.randomJobNameSuffix
true Boolean Specifies whether a random suffix should be appended to the job name.
metrics.reporter.prometheus.username
(none) String (Optional) The username for HTTP Basic Authentication with the PushGateway.