Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions internal/collector/certificatereceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
type: certificate
scope_name: otelcol/certificatereceiver

status:
class: receiver
stability:

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: the mdatagen schema requires stability to be defined at both the receiver level (status.stability: beta: [metrics]) and the metric level (stability.level: development)

beta: [metrics]
distributions: [contrib]

resource_attributes:
instance.id:
description: The nginx instance id.
type: string
enabled: true

attributes:
file_path:
description: "The full file path of the certificate."
type: string
public_key_algorithm:
description: "The public key algorithm."
type: string
serial_number:
description: "The serial number of the certificate."
type: string
subject.common_name:
description: "The Common Name of the certificate."
type: string

metrics:
nginx.certificate.expiry:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TODO: agree on name (nginx.ssl.certificate.expiry to match existing ssl metrics or different namespace to avoid potentially conflicting in the future)

enabled: true
description: "The Unix timestamp (in seconds) at which an SSL/TLS certificate expires"
stability:
level: development
gauge:
value_type: int
unit: "s"
attributes:
- file_path
- public_key_algorithm
- serial_number
- subject.common_name

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

Original file line number Diff line number Diff line change
Expand Up @@ -16,26 +16,26 @@ metrics:

Number of available logical CPUs.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| {cpu} | Sum | Int | Cumulative | false |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| {cpu} | Sum | Int | Cumulative | false | Development |

### system.cpu.utilization

Difference in system.cpu.time since the last measurement per logical CPU, divided by the elapsed time (value in interval [0,1]).

| Unit | Metric Type | Value Type |
| ---- | ----------- | ---------- |
| 1 | Gauge | Double |
| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| 1 | Gauge | Double | Development |

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| state | CPU usage type. | Str: ``idle``, ``interrupt``, ``nice``, ``softirq``, ``steal``, ``system``, ``user``, ``wait`` |
| Name | Description | Values | Requirement Level |
| ---- | ----------- | ------ | -------- |
| state | CPU usage type. | Str: ``idle``, ``interrupt``, ``nice``, ``softirq``, ``steal``, ``system``, ``user``, ``wait`` | Recommended |

## Resource Attributes

| Name | Description | Values | Enabled |
| ---- | ----------- | ------ | ------- |
| resource.id | The resource id. | Any Str | false |
| resource.id | The resource id. | 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.

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.

Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ resource_attributes:
resource.id:
description: The resource id.
type: string
enabled: true

attributes:
state:
Expand All @@ -20,19 +21,23 @@ attributes:
enum: [idle, interrupt, nice, softirq, steal, system, user, wait]

metrics:
system.cpu.utilization:
enabled: true
description: Difference in system.cpu.time since the last measurement per logical CPU, divided by the elapsed time (value in interval [0,1]).
unit: "1"
gauge:
value_type: double
attributes: [ state ]
system.cpu.logical.count:
enabled: true
description: Number of available logical CPUs.
stability:
level: development
unit: "{cpu}"
sum:
value_type: int
monotonic: false
aggregation_temporality: cumulative
system.cpu.utilization:
enabled: true
description: Difference in system.cpu.time since the last measurement per logical CPU, divided by the elapsed time (value in interval [0,1]).
stability:
level: development
unit: "1"
gauge:
value_type: double
attributes: [ state ]

Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@ metrics:

Bytes of memory in use.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic |
| ---- | ----------- | ---------- | ----------------------- | --------- |
| By | Sum | Int | Cumulative | false |
| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| By | Sum | Int | Cumulative | false | Development |

#### Attributes

| Name | Description | Values |
| ---- | ----------- | ------ |
| state | Breakdown of memory usage by type. | Str: ``buffered``, ``cached``, ``inactive``, ``free``, ``slab_reclaimable``, ``slab_unreclaimable``, ``used`` |
| Name | Description | Values | Requirement Level |
| ---- | ----------- | ------ | -------- |
| state | Breakdown of memory usage by type. | Str: ``buffered``, ``cached``, ``inactive``, ``free``, ``slab_reclaimable``, ``slab_unreclaimable``, ``used`` | Recommended |

## Resource Attributes

| Name | Description | Values | Enabled |
| ---- | ----------- | ------ | ------- |
| resource.id | The resource id. | Any Str | false |
| resource.id | The resource id. | 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.

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.

Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ resource_attributes:
resource.id:
description: The resource id.
type: string
enabled: true

attributes:
state:
Expand All @@ -23,6 +24,8 @@ metrics:
system.memory.usage:
enabled: true
description: Bytes of memory in use.
stability:
level: development
unit: By
sum:
value_type: int
Expand Down
Loading