<!-- status autogenerated section -->
# Sample Receiver

This receiver is used for testing purposes to check the output of mdatagen.

| Status        |           |
| ------------- |-----------|
| Stability     | [deprecated]: profiles   |
|               | [development]: logs   |
|               | [beta]: traces   |
|               | [stable]: metrics   |
| Deprecation of profiles | [Date]: 2025-02-05   |
|                      | [Migration Note]: no migration needed   |
| Unsupported Platforms | freebsd, illumos |
| Distributions | [] |
| Warnings      | [Any additional information that should be brought to the consumer's attention](#warnings) |
| Issues        | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector?query=is%3Aissue%20is%3Aopen%20label%3Areceiver%2Fsample%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector/issues?q=is%3Aopen+is%3Aissue+label%3Areceiver%2Fsample) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector?query=is%3Aissue%20is%3Aclosed%20label%3Areceiver%2Fsample%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector/issues?q=is%3Aclosed+is%3Aissue+label%3Areceiver%2Fsample) |
| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner)    | [@dmitryax](https://www.github.com/dmitryax) |

[deprecated]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#deprecated
[development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development
[beta]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#beta
[stable]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#stable
[Date]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#deprecation-information
[Migration Note]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#deprecation-information
<!-- end autogenerated section -->

## Warnings

This is where warnings are described.

<!-- config autogenerated section -->
## Configuration
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `endpoint` | string | localhost:12345 | **yes** | The endpoint to scrape metrics from. |
| `metrics` | object (see [metrics](#metrics)) |  | no | MetricsConfig provides config for sample metrics. |
| `resource_attributes` | object (see [resource_attributes](#resource_attributes)) |  | no | ResourceAttributesConfig provides config for sample resource attributes. |
| `sample_pkg` | object (see [sample_pkg](#sample_pkg)) |  | no |  |
| `timeout` | duration | 10s | no | Timeout for scraping metrics. |

### <a id="metrics"></a>metrics
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `default.metric` | object (see [metrics.default.metric](#metrics.default.metric)) |  | no | DefaultMetricMetricConfig provides config for the default.metric metric. |
| `default.metric.to_be_removed` | object (see [metrics.default.metric.to_be_removed](#metrics.default.metric.to_be_removed)) |  | no | DefaultMetricToBeRemovedMetricConfig provides config for the default.metric.to_be_removed metric. |
| `metric.input_type` | object (see [metrics.metric.input_type](#metrics.metric.input_type)) |  | no | MetricInputTypeMetricConfig provides config for the metric.input_type metric. |
| `optional.metric` | object (see [metrics.optional.metric](#metrics.optional.metric)) |  | no | OptionalMetricMetricConfig provides config for the optional.metric metric. |
| `optional.metric.empty_unit` | object (see [metrics.optional.metric.empty_unit](#metrics.optional.metric.empty_unit)) |  | no | OptionalMetricEmptyUnitMetricConfig provides config for the optional.metric.empty_unit metric. |
| `reaggregate.metric` | object (see [metrics.reaggregate.metric](#metrics.reaggregate.metric)) |  | no | ReaggregateMetricMetricConfig provides config for the reaggregate.metric metric. |
| `reaggregate.metric.with_required` | object (see [metrics.reaggregate.metric.with_required](#metrics.reaggregate.metric.with_required)) |  | no | ReaggregateMetricWithRequiredMetricConfig provides config for the reaggregate.metric.with_required metric. |
| `system.cpu.time` | object (see [metrics.system.cpu.time](#metrics.system.cpu.time)) |  | no | SystemCPUTimeMetricConfig provides config for the system.cpu.time metric. |
| `system.memory.usage` | object (see [metrics.system.memory.usage](#metrics.system.memory.usage)) |  | no | SystemMemoryUsageMetricConfig provides config for the system.memory.usage metric. |

### <a id="metrics.default.metric"></a>metrics.default.metric
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `aggregation_strategy` | string (one of: sum, avg, min, max) | sum | no |  |
| `attributes` | []string (one of: string_attr, state, enum_attr, slice_attr, map_attr, conditional_int_attr, conditional_string_attr, opt_in_bool_attr) | [string_attr, state, enum_attr, slice_attr, map_attr, conditional_int_attr, conditional_string_attr] | no |  |
| `enabled` | bool | true | no |  |

### <a id="metrics.default.metric.to_be_removed"></a>metrics.default.metric.to_be_removed
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `enabled` | bool | true | no |  |

### <a id="metrics.metric.input_type"></a>metrics.metric.input_type
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `aggregation_strategy` | string (one of: sum, avg, min, max) | sum | no |  |
| `attributes` | []string (one of: string_attr, state, enum_attr, slice_attr, map_attr) | [string_attr, state, enum_attr, slice_attr, map_attr] | no |  |
| `enabled` | bool | true | no |  |

### <a id="metrics.optional.metric"></a>metrics.optional.metric
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `aggregation_strategy` | string (one of: sum, avg, min, max) | avg | no |  |
| `attributes` | []string (one of: string_attr, boolean_attr, boolean_attr2, conditional_string_attr) | [string_attr, boolean_attr, boolean_attr2, conditional_string_attr] | no |  |
| `enabled` | bool | false | no |  |

### <a id="metrics.optional.metric.empty_unit"></a>metrics.optional.metric.empty_unit
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `aggregation_strategy` | string (one of: sum, avg, min, max) | avg | no |  |
| `attributes` | []string (one of: string_attr, boolean_attr) | [string_attr, boolean_attr] | no |  |
| `enabled` | bool | false | no |  |

### <a id="metrics.reaggregate.metric"></a>metrics.reaggregate.metric
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `aggregation_strategy` | string (one of: sum, avg, min, max) | avg | no |  |
| `attributes` | []string (one of: string_attr, boolean_attr) | [string_attr, boolean_attr] | no |  |
| `enabled` | bool | true | no |  |

### <a id="metrics.reaggregate.metric.with_required"></a>metrics.reaggregate.metric.with_required
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `aggregation_strategy` | string (one of: sum, avg, min, max) | avg | no |  |
| `attributes` | []string (one of: required_string_attr, string_attr, boolean_attr) | [required_string_attr, string_attr, boolean_attr] | no |  |
| `enabled` | bool | true | no |  |

### <a id="metrics.system.cpu.time"></a>metrics.system.cpu.time
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `aggregation_strategy` | string (one of: sum, avg, min, max) | sum | no |  |
| `attributes` | []string (one of: cpu) | [cpu] | no |  |
| `enabled` | bool | true | no |  |

### <a id="metrics.system.memory.usage"></a>metrics.system.memory.usage
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `aggregation_strategy` | string (one of: sum, avg, min, max) | sum | no |  |
| `attributes` | []string (one of: state) | [state] | no |  |
| `enabled` | bool | true | no |  |

### <a id="resource_attributes"></a>resource_attributes
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `map.resource.attr` | object (see [resource_attributes.map.resource.attr](#resource_attributes.map.resource.attr)) |  | no | ResourceAttributeConfig provides common config for a map.resource.attr resource attribute. |
| `optional.resource.attr` | object (see [resource_attributes.optional.resource.attr](#resource_attributes.optional.resource.attr)) |  | no | ResourceAttributeConfig provides common config for a optional.resource.attr resource attribute. |
| `slice.resource.attr` | object (see [resource_attributes.slice.resource.attr](#resource_attributes.slice.resource.attr)) |  | no | ResourceAttributeConfig provides common config for a slice.resource.attr resource attribute. |
| `string.enum.resource.attr` | object (see [resource_attributes.string.enum.resource.attr](#resource_attributes.string.enum.resource.attr)) |  | no | ResourceAttributeConfig provides common config for a string.enum.resource.attr resource attribute. |
| `string.resource.attr` | object (see [resource_attributes.string.resource.attr](#resource_attributes.string.resource.attr)) |  | no | ResourceAttributeConfig provides common config for a string.resource.attr resource attribute. |
| `string.resource.attr_disable_warning` | object (see [resource_attributes.string.resource.attr_disable_warning](#resource_attributes.string.resource.attr_disable_warning)) |  | no | ResourceAttributeConfig provides common config for a string.resource.attr_disable_warning resource attribute. |
| `string.resource.attr_remove_warning` | object (see [resource_attributes.string.resource.attr_remove_warning](#resource_attributes.string.resource.attr_remove_warning)) |  | no | ResourceAttributeConfig provides common config for a string.resource.attr_remove_warning resource attribute. |
| `string.resource.attr_to_be_removed` | object (see [resource_attributes.string.resource.attr_to_be_removed](#resource_attributes.string.resource.attr_to_be_removed)) |  | no | ResourceAttributeConfig provides common config for a string.resource.attr_to_be_removed resource attribute. |
| `string.resource.disabled_attr_to_be_removed` | object (see [resource_attributes.string.resource.disabled_attr_to_be_removed](#resource_attributes.string.resource.disabled_attr_to_be_removed)) |  | no | ResourceAttributeConfig provides common config for a string.resource.disabled_attr_to_be_removed resource attribute. |

### <a id="resource_attributes.map.resource.attr"></a>resource_attributes.map.resource.attr
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `enabled` | bool | true | no |  |
| `events_exclude` | []object |  | no | Experimental: EventsExclude defines a list of filters for attribute values. If the list is not empty, events with matching resource attribute values will not be emitted. EventsInclude has higher priority than EventsExclude. |
| `events_include` | []object |  | no | Experimental: EventsInclude defines a list of filters for attribute values. If the list is not empty, only events with matching resource attribute values will be emitted. |
| `metrics_exclude` | []object |  | no | Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude. |
| `metrics_include` | []object |  | no | Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted. |

### <a id="resource_attributes.optional.resource.attr"></a>resource_attributes.optional.resource.attr
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `enabled` | bool | false | no |  |
| `events_exclude` | []object |  | no | Experimental: EventsExclude defines a list of filters for attribute values. If the list is not empty, events with matching resource attribute values will not be emitted. EventsInclude has higher priority than EventsExclude. |
| `events_include` | []object |  | no | Experimental: EventsInclude defines a list of filters for attribute values. If the list is not empty, only events with matching resource attribute values will be emitted. |
| `metrics_exclude` | []object |  | no | Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude. |
| `metrics_include` | []object |  | no | Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted. |

### <a id="resource_attributes.slice.resource.attr"></a>resource_attributes.slice.resource.attr
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `enabled` | bool | true | no |  |
| `events_exclude` | []object |  | no | Experimental: EventsExclude defines a list of filters for attribute values. If the list is not empty, events with matching resource attribute values will not be emitted. EventsInclude has higher priority than EventsExclude. |
| `events_include` | []object |  | no | Experimental: EventsInclude defines a list of filters for attribute values. If the list is not empty, only events with matching resource attribute values will be emitted. |
| `metrics_exclude` | []object |  | no | Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude. |
| `metrics_include` | []object |  | no | Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted. |

### <a id="resource_attributes.string.enum.resource.attr"></a>resource_attributes.string.enum.resource.attr
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `enabled` | bool | true | no |  |
| `events_exclude` | []object |  | no | Experimental: EventsExclude defines a list of filters for attribute values. If the list is not empty, events with matching resource attribute values will not be emitted. EventsInclude has higher priority than EventsExclude. |
| `events_include` | []object |  | no | Experimental: EventsInclude defines a list of filters for attribute values. If the list is not empty, only events with matching resource attribute values will be emitted. |
| `metrics_exclude` | []object |  | no | Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude. |
| `metrics_include` | []object |  | no | Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted. |

### <a id="resource_attributes.string.resource.attr"></a>resource_attributes.string.resource.attr
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `enabled` | bool | true | no |  |
| `events_exclude` | []object |  | no | Experimental: EventsExclude defines a list of filters for attribute values. If the list is not empty, events with matching resource attribute values will not be emitted. EventsInclude has higher priority than EventsExclude. |
| `events_include` | []object |  | no | Experimental: EventsInclude defines a list of filters for attribute values. If the list is not empty, only events with matching resource attribute values will be emitted. |
| `metrics_exclude` | []object |  | no | Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude. |
| `metrics_include` | []object |  | no | Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted. |

### <a id="resource_attributes.string.resource.attr_disable_warning"></a>resource_attributes.string.resource.attr_disable_warning
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `enabled` | bool | true | no |  |
| `events_exclude` | []object |  | no | Experimental: EventsExclude defines a list of filters for attribute values. If the list is not empty, events with matching resource attribute values will not be emitted. EventsInclude has higher priority than EventsExclude. |
| `events_include` | []object |  | no | Experimental: EventsInclude defines a list of filters for attribute values. If the list is not empty, only events with matching resource attribute values will be emitted. |
| `metrics_exclude` | []object |  | no | Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude. |
| `metrics_include` | []object |  | no | Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted. |

### <a id="resource_attributes.string.resource.attr_remove_warning"></a>resource_attributes.string.resource.attr_remove_warning
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `enabled` | bool | false | no |  |
| `events_exclude` | []object |  | no | Experimental: EventsExclude defines a list of filters for attribute values. If the list is not empty, events with matching resource attribute values will not be emitted. EventsInclude has higher priority than EventsExclude. |
| `events_include` | []object |  | no | Experimental: EventsInclude defines a list of filters for attribute values. If the list is not empty, only events with matching resource attribute values will be emitted. |
| `metrics_exclude` | []object |  | no | Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude. |
| `metrics_include` | []object |  | no | Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted. |

### <a id="resource_attributes.string.resource.attr_to_be_removed"></a>resource_attributes.string.resource.attr_to_be_removed
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `enabled` | bool | true | no |  |
| `events_exclude` | []object |  | no | Experimental: EventsExclude defines a list of filters for attribute values. If the list is not empty, events with matching resource attribute values will not be emitted. EventsInclude has higher priority than EventsExclude. |
| `events_include` | []object |  | no | Experimental: EventsInclude defines a list of filters for attribute values. If the list is not empty, only events with matching resource attribute values will be emitted. |
| `metrics_exclude` | []object |  | no | Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude. |
| `metrics_include` | []object |  | no | Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted. |

### <a id="resource_attributes.string.resource.disabled_attr_to_be_removed"></a>resource_attributes.string.resource.disabled_attr_to_be_removed
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `enabled` | bool | false | no |  |
| `events_exclude` | []object |  | no | Experimental: EventsExclude defines a list of filters for attribute values. If the list is not empty, events with matching resource attribute values will not be emitted. EventsInclude has higher priority than EventsExclude. |
| `events_include` | []object |  | no | Experimental: EventsInclude defines a list of filters for attribute values. If the list is not empty, only events with matching resource attribute values will be emitted. |
| `metrics_exclude` | []object |  | no | Experimental: MetricsExclude defines a list of filters for attribute values. If the list is not empty, metrics with matching resource attribute values will not be emitted. MetricsInclude has higher priority than MetricsExclude. |
| `metrics_include` | []object |  | no | Experimental: MetricsInclude defines a list of filters for attribute values. If the list is not empty, only metrics with matching resource attribute values will be emitted. |

### <a id="sample_pkg"></a>sample_pkg
| Setting | Type | Default | Required | Description |
| ------- | ---- | ------- | -------- | ----------- |
| `host_name` | string | localhost | **yes** | The host name to connect to. |
| `port` | string | 8080 | **yes** | The port to connect to. |
<!-- end config autogenerated section -->
