Skip to content

Commit

Permalink
[chore][receiver/apachespark] use generated status header
Browse files Browse the repository at this point in the history
This PR updates the component to generate the status table using mdatagen.

Linked issue: open-telemetry#21213

Signed-off-by: Alex Boten <[email protected]>
  • Loading branch information
Alex Boten committed May 26, 2023
1 parent 2c8fecc commit 1a544cf
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 10 deletions.
17 changes: 9 additions & 8 deletions receiver/apachesparkreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# Apache Spark Receiver

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

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

This receiver fetches metrics for an Apache Spark cluster through the Apache Spark REST API - specifically, the /metrics/json, /api/v1/applications/[app-id]/stages, /api/v1/applications/[app-id]/executors, and /api/v1/applications/[app-id]/jobs endpoints.

Expand Down Expand Up @@ -45,6 +49,3 @@ The full list of settings exposed for this receiver are documented [here](./conf
## Metrics
Details about the metrics produced by this receiver can be found in [metadata.yaml](./metadata.yaml)
[development]: https://github.com/open-telemetry/opentelemetry-collector#development
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
2 changes: 2 additions & 0 deletions receiver/apachesparkreceiver/doc.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

//go:generate mdatagen metadata.yaml

package apachesparkreceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/apachesparkreceiver"

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

2 changes: 1 addition & 1 deletion receiver/apachesparkreceiver/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ type: apachespark
status:
class: receiver
stability:
alpha: [metrics]
development: [metrics]
distributions: [contrib]

resource_attributes:
Expand Down

0 comments on commit 1a544cf

Please sign in to comment.