Skip to content

Commit

Permalink
[chore] [receiver/flinkmetrics] switched to autogenerate status (open…
Browse files Browse the repository at this point in the history
…-telemetry#21192)

* [chore] [receiver/flinkmetrics] switched to autogenerate status
  • Loading branch information
BominRahmani committed Apr 27, 2023
1 parent a336726 commit 67eb519
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 6 deletions.
9 changes: 6 additions & 3 deletions receiver/flinkmetricsreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
# FlinkMetrics Receiver

<!-- status autogenerated section -->
| Status | |
| ------------------------ | --------- |
| ------------------------ |-----------|
| Stability | [alpha] |
| Supported pipeline types | metrics |
| Distributions | [contrib] |

[alpha]: https://github.com/open-telemetry/opentelemetry-collector#alpha
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

This receiver uses Flink's [REST API](https://nightlies.apache.org/flink/flink-docs-release-1.14/docs/ops/metrics/#rest-api-integration) to collect Jobmanager, Taskmanager, Job, Task and Operator metrics.

## Prerequisites
Expand Down Expand Up @@ -39,5 +44,3 @@ The full list of settings exposed for this receiver are documented [here](./conf

Details about the metrics produced by this receiver can be found in [metadata.yaml](./metadata.yaml)

[alpha]: https://github.com/open-telemetry/opentelemetry-collector-contrib#alpha
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
5 changes: 2 additions & 3 deletions receiver/flinkmetricsreceiver/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@ import (
)

const (
typeStr = "flinkmetrics"
stability = component.StabilityLevelAlpha
typeStr = "flinkmetrics"
)

var errConfigNotflinkmetrics = errors.New("config was not a flinkmetrics receiver config")
Expand All @@ -40,7 +39,7 @@ func NewFactory() receiver.Factory {
return receiver.NewFactory(
typeStr,
createDefaultConfig,
receiver.WithMetrics(createMetricsReceiver, stability),
receiver.WithMetrics(createMetricsReceiver, metadata.Stability),
)
}

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions receiver/flinkmetricsreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
type: flinkmetricsreceiver

status:
class: receiver
stability: alpha
pipelines: [metrics]
distributions: [contrib]

resource_attributes:
# These resource attributes are Flinks system scope variables, which contains context information about metrics. These are required to uniquely identify incoming metrics as the same job can run multiple times concurrently. See https://nightlies.apache.org/flink/flink-docs-release-1.14/docs/ops/metrics/#system-scope for more information.
host.name:
Expand Down

0 comments on commit 67eb519

Please sign in to comment.