### HTTP Receiver Configuration Example

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/confighttp/README.md

Example configuration for the OTLP HTTP receiver, demonstrating metadata inclusion, authentication, CORS settings, endpoint, and compression algorithms. It also shows an example of an attribute processor to capture client IP.

```yaml
receivers:
  otlp:
    protocols:
      http:
        include_metadata: true
        auth:
          request_params:
          - token
          authenticator: some-authenticator-extension
        cors:
          allowed_origins:
            - https://foo.bar.com
            - https://*.test.com
          allowed_headers:
            - Example-Header
          exposed_headers:
            - Example-Expose-Header
          max_age: 7200
        endpoint: 0.0.0.0:55690
        compression_algorithms: ["", "gzip"]
processors:
  attributes:
    actions:
      - key: http.client_ip
        from_context: metadata.x-forwarded-for
        action: upsert
```

--------------------------------

### HTTP Exporter Configuration Example

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/confighttp/README.md

Example configuration for an OTLP HTTP exporter, demonstrating endpoint, authentication, TLS, custom headers, and compression settings.

```yaml
exporter:
  otlp_http:
    endpoint: otelcol2:55690
    auth:
      authenticator: some-authenticator-extension
    tls:
      ca_file: ca.pem
      cert_file: cert.pem
      key_file: key.pem
    headers:
      test1: "value1"
      "test 2": "value 2"
    compression: gzip
    compression_params:
      level: 1
    cookies:
      enabled: true
```

--------------------------------

### Example .schemagen.yaml Configuration

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/schemagen/README.md

This snippet shows a typical configuration for the .schemagen.yaml file, demonstrating namespace, mappings, allowedRefs, and componentOverrides.

```yaml
namespace: github.com/open-telemetry/opentelemetry-collector-contrib
mappings:
  time:
    Duration:
      schemaType: string
      format: duration
allowedRefs:
  - go.opentelemetry.io/collector
  - github.com/open-telemetry/opentelemetry-collector-contrib
componentOverrides:
  receiver/named_pipe:
    configName: 'NamedPipeConfig'
  receiver/file_log:
    configName: 'FileLogConfig'
  receiver/prometheus:
    overlayFile: receiver/prometheusreceiver/config.schema.overlay.yaml
```

--------------------------------

### Install OCB via Go Install

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/builder/README.md

Installs the latest version of the OpenTelemetry Collector Builder using `go install`. The binary will be named `builder` and requires a compatible Go compiler in the PATH.

```console
go install go.opentelemetry.io/collector/cmd/builder@latest
```

--------------------------------

### Example Main Configuration

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/confmap/README.md

This is the primary configuration file for the OpenTelemetry Collector, defining receivers, processors, exporters, and extensions.

```yaml
# main.yaml
receivers:
  otlp/in:
processors:
  attributes/example:
    actions:
      - key: key
        value: "value"
        action: upsert

exporters:
  otlp/out:
extensions:
  file_storage:

service:
  pipelines:
    traces:
      receivers: [ otlp/in ]
      processors: [ attributes/example ]
      exporters: [ otlp/out ]
  extensions: [ file_storage ]
```

--------------------------------

### Example of Verifying Collector Image Signature

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/README.md

An example command demonstrating how to verify the signature for a specific release tag and image of the OpenTelemetry Collector.

```console
$ cosign verify --certificate-identity=https://github.com/open-telemetry/opentelemetry-collector-releases/.github/workflows/base-release.yaml@refs/tags/v0.98.0 --certificate-oidc-issuer=https://token.actions.githubusercontent.com ghcr.io/open-telemetry/opentelemetry-collector-releases/opentelemetry-collector-contrib:0.98.0
```

--------------------------------

### Example Metric Reaggregation Configuration

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/mdatagen/README.md

Example showing how to configure aggregation strategy and attributes for a specific metric. This aggregates datapoints by status_code while keeping transport.

```yaml
receivers:
  myreceiver:
    metrics:
      http.server.request.count:
        enabled: true
        aggregation_strategy: sum
        attributes: [transport]
```

--------------------------------

### Configure Example Exporters

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/README.md

Configure two instances of an example exporter with different endpoints. Exporter names are used to reference them in pipelines.

```yaml
exporters:
  # Exporter 1.
  # <exporter type>:
  exampleexporter:
    # <setting one>: <value one>
    endpoint: 1.2.3.4:8080
    # ...
  # Exporter 2.
  # <exporter type>/<name>:
  exampleexporter/settings:
    # <setting two>: <value two>
    endpoint: 0.0.0.0:9211
```

--------------------------------

### Build Custom Collector with OCB

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/builder/README.md

Installs the builder, defines a configuration file specifying components and output paths, builds the collector, and then runs the custom collector with its own configuration.

```console
$ go install go.opentelemetry.io/collector/cmd/builder@v0.129.0
$ cat > otelcol-builder.yaml <<EOF
dist:
  name: otelcol-custom
  description: Local OpenTelemetry Collector binary
  output_path: /tmp/dist
exporters:
  - gomod: github.com/open-telemetry/opentelemetry-collector-contrib/exporter/alibabacloudlogserviceexporter v0.129.0
  - gomod: go.opentelemetry.io/collector/exporter/debugexporter v0.129.0

receivers:
  - gomod: go.opentelemetry.io/collector/receiver/otlpreceiver v0.129.0

processors:
  - gomod: go.opentelemetry.io/collector/processor/batchprocessor v0.129.0

providers:
  - gomod: go.opentelemetry.io/collector/confmap/provider/envprovider v1.35.0
  - gomod: go.opentelemetry.io/collector/confmap/provider/fileprovider v1.35.0
  - gomod: go.opentelemetry.io/collector/confmap/provider/httpprovider v1.35.0
  - gomod: go.opentelemetry.io/collector/confmap/provider/httpsprovider v1.35.0
  - gomod: go.opentelemetry.io/collector/confmap/provider/yamlprovider v1.35.0
EOF
$ builder --config=otelcol-builder.yaml
$ cat > /tmp/otelcol.yaml <<EOF
receivers:
  otlp:
    protocols:
      grpc:
        endpoint: localhost:4317

exporters:
  debug:

service:
  pipelines:
    traces:
      receivers:
      - otlp
      exporters:
      - debug
EOF
$ /tmp/dist/otelcol-custom --config=/tmp/otelcol.yaml
```

--------------------------------

### Example Additional Configuration

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/confmap/README.md

This configuration file adds an additional extension to the OpenTelemetry Collector's service configuration.

```yaml
# extra_extension.yaml
extensions:
  healthcheckv2:

service:
  extensions: [ healthcheckv2 ]
  pipelines:
    traces:
```

--------------------------------

### HTTP Handler Interface Example (net/http)

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/rfcs/component-interfaces.md

Demonstrates the standard Go http.Handler interface and its corresponding HandlerFunc adapter, which serves as a prototype for the pattern used in the OpenTelemetry Collector.

```go
package http

// A Handler responds to an HTTP request.
type Handler interface {
  ServeHTTP(ResponseWriter, *Request)
}

// The HandlerFunc type is an adapter to allow the use of
// ordinary functions as HTTP handlers. If f is a function
// with the appropriate signature, HandlerFunc(f) is a
// [Handler] that calls f.
type HandlerFunc func(ResponseWriter, *Request)

// ServeHTTP calls f(w, r).
func (f HandlerFunc) ServeHTTP(w ResponseWriter, r *Request) {
  f(w, r)
}
```

--------------------------------

### Transform Processor Configuration with Multiple Queries

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/rfcs/processing.md

Example of configuring the transform processor in `config.yaml` to apply multiple transformations sequentially to traces, metrics, and logs.

```yaml
receivers:
  otlp:

exporters:
  otlp_grpc:

processors:
  transform:
    # Assuming group_by is defined in a contrib extension module, not baked into the "transform" processor
    extensions: [group_by]
    traces:
      queries:
        - drop() where attributes["http.target"] = "/health"
        - delete(attributes["http.request.header.authorization"])
        - replace_wildcards("/user/*/list/*", "/user/{userId}/list/{listId}", attributes["http.target"])
        - group_by(trace_id, 2m)
    metrics:
      queries:
        - drop() where attributes["http.target"] = "/health"
        - delete(attributes["http.request.header.authorization"])
        - replace_wildcards("/user/*/list/*", "/user/{userId}/list/{listId}", attributes["http.target"])
        - set(attributes["k8s_pod"], resource.attributes["k8s.pod.name"])
    logs:
      queries:
        - drop() where attributes["http.target"] = "/health"
        - delete(attributes["http.request.header.authorization"])
        - replace_wildcards("/user/*/list/*", "/user/{userId}/list/{listId}", attributes["http.target"])

pipelines:
  - receivers: [otlp]
    exporters: [otlp]
    processors: [transform]
```

--------------------------------

### Overlay File Example for Prometheus Scrape Config

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/schemagen/README.md

An example overlay file demonstrating how to add descriptions to Prometheus scrape configuration fields. This file mirrors the structure of the generated schema.

```yaml
# config.schema.overlay.yaml — only the keys you want to change
properties:
  prom_config:
    description: "Prometheus scrape configuration, as defined by the Prometheus documentation."
    properties:
      scrape_configs:
        description: "List of scrape configurations."
```

--------------------------------

### Metrics Builder Configuration Schema

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/mdatagen/README.md

Example `metadata.yaml` defining resource attributes and metrics for automatic generation of metrics builder configuration.

```yaml
type: myreceiver
status:
  class: receiver
  stability:
    beta: [metrics]

resource_attributes:
  transport:
    description: Transport used by the request.
    type: string
    enabled: true

attributes:
  status_code:
    description: Response status code.
    type: int
    requirement_level: opt_in

metrics:
  http.server.request.count:
    enabled: true
    description: Number of received requests.
    unit: "{request}"
    sum:
      value_type: int
      monotonic: true
      aggregation_temporality: cumulative
    attributes: [status_code]
```

--------------------------------

### Component Config Documentation Schema

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/mdatagen/README.md

Example `metadata.yaml` with a `config` section to define a JSON Schema for component configuration, enabling IDE features.

```yaml
type: myreceiver
status:
  class: receiver
  stability:
    beta: [metrics, traces]

config:
  type: object
  properties:
    endpoint:
      type: string
      description: The endpoint to listen on
      default: "localhost:4317"
    timeout:
      type: string
      format: duration
      description: Request timeout duration
      default: "30s"
    tls:
      $ref: go.opentelemetry.io/collector/config/configtls.server_config
  required: [endpoint]
```

--------------------------------

### Basic Verbosity Output Example

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/debugexporter/README.md

Example console output when the debug exporter is configured with basic verbosity, showing a summary of received trace data.

```console
2025-04-17T10:40:44.559+0200    info    Traces  {"otelcol.component.id": "debug/basic", "otelcol.component.kind": "Exporter", "otelcol.signal": "traces", "resource spans": 1, "spans": 2}
```

--------------------------------

### Custom Go Annotation Example

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/rfcs/component-configuration-schema-roadmap.md

Demonstrates how to use the 'go' annotation within a schema to specify custom Go types, pointers, optional fields, and custom validation snippets for generated code.

```yaml
some_optional_field:
 type: string
 go:
  type: com.github/custom/custompkg.CustomType
  pointer: true
  optional: true
  custom: ['validate']

```

--------------------------------

### YAML Configuration Example with Null Map

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/confmap/README.md

This YAML snippet demonstrates a configuration where 'processors' is treated as null due to its empty value, which can lead to errors when merging configurations.

```yaml
processors:

```

--------------------------------

### Function Renaming Migration Example

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/coding-guidelines.md

Shows how to handle function renaming by aliasing the old function to the new one and adding a deprecation warning. This is part of a two-step migration process.

```golang
func GetFoo() Bar {
    // Deprecated: [v0.N+1] Use GetBar instead.
    return GetBar()
}
```

--------------------------------

### Example of Correct Component Naming

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/coding-guidelines.md

Component identifiers must use lower_snake_case for consistency and readability in configuration files. Go package names follow standard Go conventions.

```go
memory_limiter
otlp_http
```

--------------------------------

### Example URI Fragment Configuration

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/rfcs/configuring-confmap-providers.md

Demonstrates how to specify options like refresh intervals and headers using a URI fragment with encoded query parameters. This approach allows for dynamic configuration values from environment variables or files.

```text
https://config.com/config#refresh-interval=env:REFRESH_INTERVAL&headers=file:headers.yaml
```

--------------------------------

### Example Component Configuration Schema

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/rfcs/component-configuration-schema-roadmap.md

Illustrates a YAML schema for component configuration, including properties like targets with host, ping count, interval, and timeout, as well as custom fields with Go-specific annotations.

```yaml
config:
  type: object
  properties:
    targets:
      type: array
      items:
        type: object
        properties:
          host:
            type: string
            description: "Target hostname or IP address"
          ping_count:
            type: integer
            description: "Number of pings to send"
            default: 4
          ping_interval:
            type: string
            description: "Interval between pings"
            format: duration
            default: 300ms
          ping_timeout:
            type: string
            description: "Timeout of ping request"
            format: duration
            default: 4s
      required: [ host ]
      minItems: 1
    custom_field:
      go:
        custom: ['type', 'default', 'validate']
  required: [ targets ]
  allOf:
    - $ref: 'go.opentelemetry.io/collector/scraper/scraperhelper.controller_config'
    - $ref: './internal/metadata.metrics_builder_config'

```

--------------------------------

### Report Fatal Error in Component Start

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/rfcs/component-status-reporting.md

Use `host.ReportFatalError` within a component's Start method to signal a critical error that requires the collector to shut down. This is particularly useful for reporting errors from asynchronous operations like starting a server.

```golang
if errHTTP := fmr.server.Serve(listener); errHTTP != nil && !errors.Is(errHTTP, http.ErrServerClosed) {
   host.ReportFatalError(errHTTP)
}
```

--------------------------------

### Deprecated Metric Example

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/mdatagen/internal/sampleconnector/documentation.md

Example configuration for a deprecated non-monotonic delta sum double metric. This metric will be removed soon.

```yaml
metrics:
  default.metric.to_be_removed:
    enabled: true
```

--------------------------------

### Naked Syntax Example (os.Expand)

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/rfcs/env-vars.md

Demonstrates the supported identifiers for the naked environment variable syntax ($ENV), which uses os.Expand. Identifiers can include alphanumerics, underscore, and certain special characters. Values are always strings.

```go
package main

import (
	"fmt"
	"os"
)

func main() {
	// Example demonstrating os.Expand with naked syntax
	// Note: This is a conceptual example, the actual play link is illustrative.
	// The actual behavior is within the OpenTelemetry Collector's confmap expansion.
	data := "Hello, $USER! Your path is $PATH."
	os.Setenv("USER", "testuser")
	os.Setenv("PATH", "/usr/local/bin")

	expanded := os.Expand(data, func(envKey string) string {
		return os.Getenv(envKey)
	})

	fmt.Println(expanded)
}

```

--------------------------------

### Default Metric Example

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/mdatagen/internal/sampleconnector/documentation.md

Example of a default monotonic cumulative sum integer metric. It is enabled by default and has various attributes.

```yaml
metrics:
  default.metric:
    enabled: true
```

--------------------------------

### Basic Builder Configuration

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/builder/README.md

The basic command to run the builder with a configuration file.

```bash
ocb --config=config.yaml
```

--------------------------------

### Run Tests, Fmt, and Lint

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/CONTRIBUTING.md

Execute the default Make target to run tests, format code, and perform linting.

```bash
make
```

--------------------------------

### Spatial Reaggregation Metric Example

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/mdatagen/internal/sampleconnector/documentation.md

Example configuration for a metric used for testing spatial reaggregation. It is a double gauge metric with beta stability.

```yaml
metrics:
  reaggregate.metric:
    enabled: true
```

--------------------------------

### Handle Optional TLS Settings in Listener Creation

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/rfcs/optional-config-type.md

Demonstrates how to check for and use an optional TLS configuration when creating a network listener. If `TLSSetting` has a value, it's used to wrap the listener.

```golang
func (sc *ServerConfig) ToListener(ctx context.Context) (net.Listener, error) {
  listener, err := net.Listen("tcp", sc.Endpoint)
  if err != nil {
    return nil, err
  }

  if sc.TLSSetting.HasValue() {
    var tlsCfg *tls.Config
    tlsCfg, err = sc.TLSSetting.Value().LoadTLSConfig(ctx)
    if err != nil {
     return nil, err
    }
    tlsCfg.NextProtos = []string{http2.NextProtoTLS, "http/1.1"}
    listener = tls.NewListener(listener, tlsCfg)
  }

  return listener, nil
}
```

--------------------------------

### Define Custom Metrics in metadata.yaml

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/coding-guidelines.md

Example of defining custom metrics for a component in `metadata.yaml`. Includes examples for histogram, counter, and gauge types with descriptions, units, and configuration.

```yaml
telemetry:
  metrics:
    # example of a histogram
    processor.tailsampling.samplingdecision.latency:
      description: Latency (in microseconds) of a given sampling policy.
      unit: "µs" # from https://ucum.org/ucum
      enabled: true
      histogram:
        value_type: int
        # bucket boundaries can be overridden
        bucket_boundaries: [1, 2, 5, 10, 25, 50, 75, 100, 150, 200, 300, 400, 500, 750, 1000, 2000, 3000, 4000, 5000, 10000, 20000, 30000, 50000]

    # example of a counter
    processor.tailsampling.policyevaluation.errors:
      description: Count of sampling policy evaluation errors.
      unit: "{errors}"
      enabled: true
      sum:
        value_type: int
        monotonic: true

    # example of a gauge
    processor.tailsampling.tracesonmemory:
      description: Tracks the number of traces current on memory.
      unit: "{traces}"
      enabled: true
      gauge:
        value_type: int
```

--------------------------------

### Go Get Command with Major Version

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/VERSIONING.md

When using `go get` for modules version v2 or higher, include the major version in both the module name and the version tag.

```bash
go get go.opentelemetry.io/collector/v2@v2.0.1
```

--------------------------------

### Braces Syntax Example (os.Expand)

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/rfcs/env-vars.md

Illustrates the braces syntax (${ENV}) for environment variable resolution, also implemented using os.Expand. This syntax supports identifiers that do not contain '}'. Values are always strings.

```go
package main

import (
	"fmt"
	"os"
)

func main() {
	// Example demonstrating os.Expand with braces syntax
	// Note: This is a conceptual example, the actual play link is illustrative.
	// The actual behavior is within the OpenTelemetry Collector's confmap expansion.
	data := "Hello, ${USER}! Your path is ${PATH}."
	os.Setenv("USER", "testuser")
	os.Setenv("PATH", "/usr/local/bin")

	expanded := os.Expand(data, func(envKey string) string {
		return os.Getenv(envKey)
	})

	fmt.Println(expanded)
}

```

--------------------------------

### Configuring Headers with map or list of pairs

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/CHANGELOG-API.md

Demonstrates how to configure headers using either a map or a list of name/value pairs with `configopaque.MapList`.

```yaml
headers:
  "foo": "bar"
```

```yaml
headers:
- name: "foo"
  value: "bar"
```

--------------------------------

### Go Get Command for Contrib Module with Major Version

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/VERSIONING.md

When fetching a specific version of a contrib module that is v2 or higher, use `go get` with the module path including the major version and the version tag.

```bash
go get github.com/open-telemetry/opentelemetry-collector-contrib/processor/k8sprocessor/v2@v2.0.1
```

--------------------------------

### Generate Telemetry Data with telemetrygen

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/exporter/debugexporter/generating-example-output.md

Use the telemetrygen tool to generate trace data and send it to the Collector. Install the tool using 'go install' and run it with the '--otlp-insecure' flag to send data without TLS.

```console
telemetrygen traces --otlp-insecure
```

--------------------------------

### Sealed Receiver Factory Interface Example

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/rfcs/component-interfaces.md

Demonstrates a sealed `Factory` interface for receivers, preventing external implementations and allowing safe evolution through functional options. New signals can be added by introducing new methods, corresponding function types, and options.

```go
type Factory interface {
    // Embed a sealed interface from another module
    component.Factory
    
    // Traces-specific methods
    CreateTraces(...) (Traces, error)
    TracesStability() component.StabilityLevel

    // ... additional methods for other signals

unexportedFactoryFunc() // sealing method
}

// <Method>Func for CreateTraces
type CreateTracesFunc func(context.Context, Settings, component.Config, consumer.Traces) (Traces, error)

// Functional option for traces capability
func WithTraces(createTraces CreateTracesFunc, sl component.StabilityLevel) FactoryOption { ... }

// Constructor uses functional options
func NewFactory(cfgType component.Type, createDefaultConfig component.CreateDefaultConfigFunc, options ...FactoryOption) Factory
```

--------------------------------

### Fork Trace Pipelines with Forward Connector

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/connector/forwardconnector/README.md

This example shows how to fork a single trace pipeline into two distinct paths: 'traces/hot' and 'traces/cold'. Data from the initial 'traces' pipeline is sent to the 'forward' connector, which then directs it to two separate pipelines, each with its own processor and exporter.

```yaml
receivers:
  foo:
processors:
  resourcedetection:
  sample:
  attributes:
exporters:
  bar/hot:
  bar/cold:
connectors:
  forward:
service:
  pipelines:
    traces:
      receivers: [foo]
      processors: [resourcedetection]
      exporters: [forward]
    traces/hot:
      receivers: [forward]
      processors: [sample]
      exporters: [bar/hot]
    traces/cold:
      receivers: [forward]
      processors: [attributes]
      exporters: [bar/cold]

```

--------------------------------

### Reduce Attribute Cardinality

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/rfcs/processing.md

Normalize attribute values to reduce cardinality, for example, by replacing specific user IDs with a placeholder.

```yaml
traces:
  replace_match(attributes["http.target"], "/user/*/list/*", "/user/{userId}/list/{listId}")
```

--------------------------------

### Deprecated Function Godoc Example

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/coding-guidelines.md

Illustrates how to mark a Go function as deprecated with a version and alternative. Use this for tracking deprecation.

```golang
package test

// Deprecated: [v0.45.0] Use MustDoFoo instead.
func DoFoo() {}
```

--------------------------------

### Debugging with Delve

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/builder/README.md

Install Delve and run the OpenTelemetry Collector with dlv for debugging. Ensure debugging symbols are preserved and optimizations are disabled.

```bash
# go install github.com/go-delve/delve/cmd/dlv@latest
# ~/go/bin/dlv --listen=:2345 --headless=true --api-version=2 --accept-multiclient --log exec .otel-collector-binary -- --config otel-collector-config.yaml
```

--------------------------------

### go:generate directive for mdatagen

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/mdatagen/README.md

A `doc.go` file example showing the `go:generate mdatagen` directive to trigger metadata generation.

```go
//go:generate mdatagen metadata.yaml

package main
```

--------------------------------

### Pull Official OCB Docker Image

Source: https://github.com/open-telemetry/opentelemetry-collector/blob/main/cmd/builder/README.md

Pulls the latest Docker image for the OpenTelemetry Collector Builder from DockerHub. This is the recommended installation method.

```console
docker pull otel/opentelemetry-collector-builder:latest
```