Skip to content

Commit

Permalink
[receiver/k8scluster] Change k8s.job metrics to use mdatagen (#24182)
Browse files Browse the repository at this point in the history
Change k8s.job metrics to use mdatagen.

**Link to tracking Issue:**
#4367
  • Loading branch information
povilasv authored Jul 13, 2023
1 parent 343fbff commit 7dea812
Show file tree
Hide file tree
Showing 14 changed files with 1,143 additions and 134 deletions.
20 changes: 20 additions & 0 deletions .chloggen/k8s-cluster-receiver-jobs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Use this changelog template to create an entry for release notes.
# If your change doesn't affect end users, such as a test fix or a tooling change,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: enhancement

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: k8sclusterreceiver

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: "Refactor k8s.job metrics to use mdatagen"

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [10553]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext: ""
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ func (dc *DataCollector) SyncMetrics(obj interface{}) {
case *appsv1.StatefulSet:
md = statefulset.GetMetrics(dc.settings, o)
case *batchv1.Job:
md = ocsToMetrics(jobs.GetMetrics(o))
md = jobs.GetMetrics(dc.settings, o)
case *batchv1.CronJob:
md = ocsToMetrics(cronjob.GetMetrics(o))
case *batchv1beta1.CronJob:
Expand Down
6 changes: 6 additions & 0 deletions receiver/k8sclusterreceiver/internal/jobs/docs.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0

//go:generate mdatagen metadata.yaml

package jobs // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/k8sclusterreceiver/internal/jobs"
64 changes: 64 additions & 0 deletions receiver/k8sclusterreceiver/internal/jobs/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
[comment]: <> (Code generated by mdatagen. DO NOT EDIT.)

# k8s/job

**Parent Component:** k8s_cluster

## Default Metrics

The following metrics are emitted by default. Each of them can be disabled by applying the following configuration:

```yaml
metrics:
<metric_name>:
enabled: false
```
### k8s.job.active_pods
The number of actively running pods for a job
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| 1 | Gauge | Int |
### k8s.job.desired_successful_pods
The desired number of successfully finished pods the job should be run with
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| 1 | Gauge | Int |
### k8s.job.failed_pods
The number of pods which reached phase Failed for a job
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| 1 | Gauge | Int |
### k8s.job.max_parallel_pods
The max desired number of pods the job should run at any given time
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| 1 | Gauge | Int |
### k8s.job.successful_pods
The number of pods which reached phase Succeeded for a job
| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| 1 | Gauge | Int |
## Resource Attributes
| Name | Description | Values | Enabled |
| ---- | ----------- | ------ | ------- |
| k8s.job.name | The k8s pod name. | Any Str | true |
| k8s.job.uid | The k8s job uid. | Any Str | true |
| k8s.namespace.name | The k8s namespace name. | Any Str | true |
| opencensus.resourcetype | The OpenCensus resource type. | Any Str | true |

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

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

Loading

0 comments on commit 7dea812

Please sign in to comment.