[comment]: <> (Code generated by mdatagen. DO NOT EDIT.)

# sample

## 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
```

### default.metric

Monotonic cumulative sum int metric enabled by default.

The metric will be become optional soon.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| s | Sum | Int | Cumulative | true | Deprecated since 1.0.0 |

**Deprecation note**: This metric will be removed

#### Attributes

| Name | Description | Values | Requirement Level | Semantic Convention |
| ---- | ----------- | ------ | ----------------- | ------------------- |
| string_attr | Attribute with any string value. | Any Str | Recommended | - |
| state | Integer attribute with overridden name. | Any Int | Recommended | - |
| enum_attr | Attribute with a known set of string values. | Str: ``red``, ``green``, ``blue`` | Recommended | - |
| slice_attr | Attribute with a slice value. | Any Slice | Recommended | - |
| map_attr | Attribute with a map value. | Any Map | Recommended | - |
| conditional_int_attr | A conditional attribute with an integer value | Any Int | Conditionally Required | - |
| conditional_string_attr | A conditional attribute with any string value | Any Str | Conditionally Required | - |
| opt_in_bool_attr | An opt-in attribute with a boolean value | Any Bool | Opt-In | - |

### default.metric.to_be_removed

[DEPRECATED] Non-monotonic delta sum double metric enabled by default.

The metric will be removed soon.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| s | Sum | Double | Delta | false | Deprecated since 1.0.0 |

**Deprecation note**: This metric will be removed

### metric.input_type

Monotonic cumulative sum int metric with string input_type enabled by default.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- |
| s | Sum | Int | Cumulative | true | Development |

#### Attributes

| Name | Description | Values | Requirement Level | Semantic Convention |
| ---- | ----------- | ------ | ----------------- | ------------------- |
| string_attr | Attribute with any string value. | Any Str | Recommended | - |
| state | Integer attribute with overridden name. | Any Int | Recommended | - |
| enum_attr | Attribute with a known set of string values. | Str: ``red``, ``green``, ``blue`` | Recommended | - |
| slice_attr | Attribute with a slice value. | Any Slice | Recommended | - |
| map_attr | Attribute with a map value. | Any Map | Recommended | - |

### reaggregate.metric

Metric for testing spatial reaggregation

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

#### Attributes

| Name | Description | Values | Requirement Level | Semantic Convention |
| ---- | ----------- | ------ | ----------------- | ------------------- |
| string_attr | Attribute with any string value. | Any Str | Recommended | - |
| boolean_attr | Attribute with a boolean value. | Any Bool | Recommended | - |

### reaggregate.metric.with_required

Metric for testing spatial reaggregation with required attributes

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

#### Attributes

| Name | Description | Values | Requirement Level | Semantic Convention |
| ---- | ----------- | ------ | ----------------- | ------------------- |
| required_string_attr | A required attribute with a string value | Any Str | Required | - |
| string_attr | Attribute with any string value. | Any Str | Recommended | - |
| boolean_attr | Attribute with a boolean value. | Any Bool | Recommended | - |

### system.cpu.time

Monotonic cumulative sum int metric enabled by default.

The metric will be become optional soon.

| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | Stability | Semantic Convention |
| ---- | ----------- | ---------- | ----------------------- | --------- | --------- | ------------------- |
| s | Sum | Int | Cumulative | true | Beta | [system.cpu.time](https://github.com/open-telemetry/semantic-conventions/blob/v1.40.0/docs/system/system-metrics.md#metric-systemcputime) |

#### Attributes

| Name | Description | Values | Requirement Level | Semantic Convention |
| ---- | ----------- | ------ | ----------------- | ------------------- |
| cpu | Logical CPU number starting at 0. | Any Str | Recommended | - |

### system.memory.usage

Bytes of memory in use.

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

#### Attributes

| Name | Description | Values | Requirement Level | Semantic Convention |
| ---- | ----------- | ------ | ----------------- | ------------------- |
| state | Breakdown of memory usage by type. | Str: ``buffered``, ``cached``, ``inactive``, ``free``, ``slab_reclaimable``, ``slab_unreclaimable``, ``used`` | Recommended | [state](https://github.com/open-telemetry/semantic-conventions/blob/v1.40.0/docs/registry/attributes/system.md#system-memory-state) |

## Optional Metrics

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

```yaml
metrics:
  <metric_name>:
    enabled: true
```

### optional.metric

[DEPRECATED] Gauge double metric disabled by default.

| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| 1 | Gauge | Double | Deprecated since 1.0.0 |

**Deprecation note**: This metric will be removed

#### Attributes

| Name | Description | Values | Requirement Level | Semantic Convention |
| ---- | ----------- | ------ | ----------------- | ------------------- |
| string_attr | Attribute with any string value. | Any Str | Recommended | - |
| boolean_attr | Attribute with a boolean value. | Any Bool | Recommended | - |
| boolean_attr2 | Another attribute with a boolean value. | Any Bool | Recommended | - |
| conditional_string_attr | A conditional attribute with any string value | Any Str | Conditionally Required | - |

### optional.metric.empty_unit

[DEPRECATED] Gauge double metric disabled by default.

| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
|  | Gauge | Double | Deprecated since 1.0.0 |

**Deprecation note**: This metric will be removed

#### Attributes

| Name | Description | Values | Requirement Level | Semantic Convention |
| ---- | ----------- | ------ | ----------------- | ------------------- |
| string_attr | Attribute with any string value. | Any Str | Recommended | - |
| boolean_attr | Attribute with a boolean value. | Any Bool | Recommended | - |

## Default Events

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

```yaml
events:
  <event_name>:
    enabled: false
```

### default.event

Example event enabled by default.

#### Attributes

| Name | Description | Values | Semantic Convention |
| ---- | ----------- | ------ | ------------------- |
| string_attr | Attribute with any string value. | Any Str | - |
| state | Integer attribute with overridden name. | Any Int | - |
| enum_attr | Attribute with a known set of string values. | Str: ``red``, ``green``, ``blue`` | - |
| slice_attr | Attribute with a slice value. | Any Slice | - |
| map_attr | Attribute with a map value. | Any Map | - |
| conditional_int_attr | A conditional attribute with an integer value | Any Int | - |
| conditional_string_attr | A conditional attribute with any string value | Any Str | - |
| opt_in_bool_attr | An opt-in attribute with a boolean value | Any Bool | - |

### default.event.to_be_removed

[DEPRECATED] Example to-be-removed event enabled by default.

The event will be removed soon.

#### Attributes

| Name | Description | Values | Semantic Convention |
| ---- | ----------- | ------ | ------------------- |
| string_attr | Attribute with any string value. | Any Str | - |
| state | Integer attribute with overridden name. | Any Int | - |
| enum_attr | Attribute with a known set of string values. | Str: ``red``, ``green``, ``blue`` | - |
| slice_attr | Attribute with a slice value. | Any Slice | - |
| map_attr | Attribute with a map value. | Any Map | - |

## Optional Events

The following events are not emitted by default. Each of them can be enabled by applying the following configuration:

```yaml
events:
  <event_name>:
    enabled: true
```

### default.event.to_be_renamed

[DEPRECATED] Example event disabled by default.

The event will be renamed soon.

#### Attributes

| Name | Description | Values | Semantic Convention |
| ---- | ----------- | ------ | ------------------- |
| string_attr | Attribute with any string value. | Any Str | - |
| boolean_attr | Attribute with a boolean value. | Any Bool | - |
| boolean_attr2 | Another attribute with a boolean value. | Any Bool | - |
| conditional_string_attr | A conditional attribute with any string value | Any Str | - |

## Resource Attributes

| Name | Description | Values | Enabled | Semantic Convention |
| ---- | ----------- | ------ | ------- | ------------------- |
| map.resource.attr | Resource attribute with a map value. | Any Map | true | - |
| optional.resource.attr | Explicitly disabled ResourceAttribute. | Any Str | false | - |
| slice.resource.attr | Resource attribute with a slice value. | Any Slice | true | - |
| string.enum.resource.attr | Resource attribute with a known set of string values. | Str: ``one``, ``two`` | true | - |
| string.resource.attr | Resource attribute with any string value. | Any Str | true | - |
| string.resource.attr_disable_warning | Resource attribute with any string value. | Any Str | true | - |
| string.resource.attr_remove_warning | Resource attribute with any string value. | Any Str | false | - |
| string.resource.attr_to_be_removed | Resource attribute with any string value. | Any Str | true | - |
| string.resource.disabled_attr_to_be_removed | Resource attribute with any string value. | Any Str | false | - |

## Internal Telemetry

The following telemetry is emitted by this component.

### otelcol_batch_size_trigger_send

Number of times the batch was sent due to a size trigger

> **Deprecated since 1.5.0**
> This metric will be removed in favor of batch_send_trigger_size

| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| {time} | Sum | Int | true | Deprecated since 1.5.0 |

**Deprecation note**: This metric will be removed in favor of batch_send_trigger_size

### otelcol_process_runtime_total_alloc_bytes

Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc')

| Unit | Metric Type | Value Type | Monotonic | Stability |
| ---- | ----------- | ---------- | --------- | --------- |
| By | Sum | Int | true | Stable |

### otelcol_queue_capacity

Queue capacity - sync gauge example.

| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| {item} | Gauge | Int | Development |

### otelcol_queue_length

This metric is optional and therefore not initialized in NewTelemetryBuilder.

For example this metric only exists if feature A is enabled.

| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| {item} | Gauge | Int | Alpha |

### otelcol_request_duration

Duration of request

| Unit | Metric Type | Value Type | Stability |
| ---- | ----------- | ---------- | --------- |
| s | Histogram | Double | Alpha |

## Feature Gates

This component has the following feature gates:

| Feature Gate | Stage | Description | From Version | To Version | Reference |
| ------------ | ----- | ----------- | ------------ | ---------- | --------- |
| `receiver.sample.featuregate.example` | alpha | This is an example feature gate for testing mdatagen code generation. | v0.100.0 | N/A | [Link](https://github.com/open-telemetry/opentelemetry-collector/issues/12345) |

For more information about feature gates, see the [Feature Gates](https://github.com/open-telemetry/opentelemetry-collector/blob/main/featuregate/README.md) documentation.
