OpenTelemetry Go Contrib

https://pkg.go.dev/go.opentelemetry.io/contrib
Admin
OpenTelemetry Go Contrib is a collection of third-party packages providing instrumentation,...
Tokens:154,135
Snippets:1,985
Trust Score:9.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start go-restful Server and Client

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/emicklei/go-restful/example

Use this command to bring up the go-restful server and client services for the example. Ensure Docker Compose is installed.

```bash
docker-compose up --detach go-restful-server go-restful-client

```

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

### Start the instrumentation example

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda/example

Initializes the project environment using Docker Compose.

```bash
docker-compose up --detach
```

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

### Start Docker Compose Services

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/example

Use this command to bring up the necessary services for the example. Ensure Docker Compose is installed.

```bash
docker-compose up --detach mux-server mux-client

```

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

### Start go-kit Server and Client

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/go-kit/kit/otelkit/example

Starts the kit-server and kit-client services using docker-compose. Ensure docker-compose is installed before running.

```bash
docker-compose up --detach kit-server kit-client

```

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

### Start Zipkin Services

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/examples/zipkin

Bring up the zipkin-collector and zipkin-client services to send an example trace. Ensure docker-compose is installed.

```bash
docker-compose up --detach zipkin-collector zipkin-client

```

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

### Start Gin-Gonic Server and Client Services

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/gin-gonic/gin/example

Use this command to bring up the necessary Docker Compose services for the Gin-Gonic instrumentation example. Ensure Docker Compose is installed.

```bash
docker-compose up --detach gin-server gin-client

```

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

### Start Kafka and ZooKeeper Services

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/Shopify/sarama/example

Use docker-compose to bring up the Kafka and ZooKeeper services for the example.

```bash
docker-compose up -d zoo kafka

```

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

### Running the Integration Example

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql/example

Instructions to set up and run the gocql integration example. Requires Docker Compose for Cassandra and Zipkin.

```bash
cd <example_directory>
docker-compose up
go run .
```

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

### Run Echo instrumentation example

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/labstack/echo/otelecho/example

Starts the echo-server and echo-client services in the background.

```bash
docker-compose up --detach echo-server echo-client
```

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

### Install the Lambda Resource Detector

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/detectors/aws/lambda

Use the go get command to add the detector package to your Go project.

```bash
go get -u go.opentelemetry.io/contrib/detectors/aws/lambda
```

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

### Run the Go Example Program

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/samplers/jaegerremote

Execute the example program to observe the Jaeger remote sampler fetching strategies.

```bash
go run .
```

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

### Run Integration Example

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql/otelgocql/example

Instructions to run the integration example. Requires Docker Compose for Cassandra and Zipkin, and then running the Go program. Spans and metrics can be viewed at specified local addresses.

```bash
cd <example_directory>
docker-compose up
go run .

```

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

### Environment Example Output

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/processors/minsev

Output from the environment variable Severitier example.

```text
Output:
false
true
```

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

### Install xrayconfig package

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda/xrayconfig

Use the go get command to add the xrayconfig package to your project.

```bash
go get -u go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda/xrayconfig
```

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

### Start Host Metrics

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/host

Initializes the reporting of host metrics.

```go
func Start(opts ...Option) error
```

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

### Install otellambda

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda

Command to install the otellambda instrumentation package.

```bash
go get -u go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda
```

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

### Instrgen Example with Wildcard

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrgen

This example demonstrates instrumenting all packages within the specified testdata path using the './...' wildcard.

```bash
./instrgen --inject ./testdata/basic ./...

```

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

### Install the AWS Elastic Beanstalk Detector

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/detectors/aws/elasticbeanstalk

Use the go get command to add the detector package to your Go project.

```bash
go get -u go.opentelemetry.io/contrib/detectors/aws/elasticbeanstalk
```

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

### Run AWS SDK V2 instrumentation example

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-sdk-go-v2/otelaws/example

Commands to manage the lifecycle of the instrumentation example environment using Docker Compose.

```bash
docker-compose up --detach
```

```bash
docker-compose logs
```

```bash
docker-compose down
```

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

### Inject Start Time into Context

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

Returns a new context containing the provided start time for metrics and traces.

```go
func ContextWithStartTime(parent context.Context, start time.Time) context.Context
```

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

### ChildProcess Example Output

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/propagators/envcar

Example output showing the trace context injected into a child process environment.

```text
Output:
00-0102030405060708090a0b0c0d0e0f10-0102030405060708-01
```

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

### Datadog Exporter Example Output

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/metric/datadog

Example of the metric format sent to Datadog.

```go
mycounter:151|c|#env:dev,l:1,service.name:ExampleExporter,telemetry.sdk.language:go,telemetry.sdk.name:opentelemetry,telemetry.sdk.version:1.4.0
```

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

### ExtractFromParent Example Output

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/propagators/envcar

Example output showing trace information extracted from environment variables into a context.

```text
Output:
Trace ID: 0102030405060708090a0b0c0d0e0f10
Span ID: 0102030405060708
Sampled: true
```

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

### Stop Integration Example

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql/otelgocql/example

Instructions to stop and clean up resources after running the integration example. This involves stopping the Go program and then stopping the Docker Compose services.

```bash
ctrl+c
docker-compose down
```

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

### Install Cortex Exporter

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/metric/cortex

Installs the Cortex exporter and sets up a new push controller. Requires a Config struct and returns the controller and an error. Defer stopping the controller.

```go
go get -u go.opentelemetry.io/contrib/exporters/metric/cortex

```

```go
// Create a Config struct named `config`.

controller, err := cortex.InstallNewPipeline(config)
if err != nil {
    return err
}
deferr controller.Stop(context.Background())

// Make instruments and record data using `global.MeterProvider`.


```

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

### Run Docker Compose

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/metric/cortex/example

Starts the Docker services for the Cortex exporter example in detached mode.

```bash
docker-compose up -d
```

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

### Start Kafka Consumer Service

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/Shopify/sarama/example

Use docker-compose to start the kafka-consumer service to receive messages from Kafka.

```bash
docker-compose up kafka-consumer

```

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

### Start Kafka Producer Service

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/Shopify/sarama/example

Use docker-compose to start the kafka-producer service to send messages to Kafka.

```bash
docker-compose up kafka-producer

```

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

### func Start(opts ...Option) error

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/host

Initializes the reporting of host metrics using the provided configuration options.

```APIDOC
## func Start(opts ...Option) error

### Description
Initializes reporting of host metrics using the supplied configuration options. This function should be called to begin collecting and reporting system metrics.

### Parameters
- **opts** (...Option) - Optional - A variadic list of configuration options to customize the host metric reporting.

### Returns
- **error** - Returns an error if the initialization fails, otherwise nil.
```

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

### Install OpenTelemetry Pipeline with Cortex Exporter

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/metric/cortex

Installs a push Controller's MeterProvider globally, registering it with the OpenTelemetry SDK. Use this function to set up the default pipeline for metric collection and export.

```go
func InstallNewPipeline(config Config, options ...controller.Option) (*controller.Controller, error)
```

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

### func Start(opts ...Option) error

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/runtime

Initializes the reporting of runtime metrics using the provided configuration options. This function enables standard Go runtime metrics collection.

```APIDOC
## func Start(opts ...Option) error

### Description
Initializes reporting of runtime metrics using the supplied configuration. This function starts the background collection of metrics such as memory usage, goroutine counts, and processor limits.

### Parameters
- **opts** (...Option) - Optional - Configuration options for the runtime metrics, such as MeterProvider or memory stats interval.
```

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

### NewTextMapPropagator Examples

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/propagators/autoprop

Demonstrates the output of NewTextMapPropagator under different configurations, including default, arguments, and environment variable settings.

```go
Output:
[baggage traceparent tracestate]
```

```go
Output:
[b3 baggage traceparent tracestate]
```

```go
Output:
[b3 baggage]
```

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

### Severity String Representation Examples

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/processors/minsev

Examples of how Severity levels are converted to string representations.

```go
SeverityWarn1.String() => "WARN"
(SeverityInfo1+2).String() => "INFO3"
(SeverityFatal4+2).String() => "FATAL+6"
(SeverityTrace1-3).String() => "TRACE-3"
```

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

### Install DogStatsD Pipeline

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/metric/dogstatsd

Installs a new DogStatsD export pipeline and registers it globally. Typically called with a configuration object.

```go
func InstallNewPipeline(config Config) (*controller.Controller, error)
```

```go
pipeline, err := dogstatsd.InstallNewPipeline(dogstatsd.Config{
	// ... configuration ...
})
if err != nil {
	// ... handle error ...
}
defer pipeline.Stop()
// ... use pipeline ...

```

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

### Configure Handler with Additional Span Start Options

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http

Use WithSpanOptions to apply extra trace.StartOptions to each new span. These options are merged with any default options.

```go
func WithSpanOptions(opts ...trace.StartOption) Option
```

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

### Get Recommended X-Ray Options

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda/xrayconfig

Returns a collection of recommended otellambda options for use with AWS X-Ray.

```go
func WithRecommendedOptions(tp *sdktrace.TracerProvider) []otellambda.Option
```

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

### Start Runtime Metrics Collection

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/plugins/runtime

Begins regular background polling of Go runtime metrics. Returns an error if any issues occur during startup.

```Go
func (r *Runtime) Start() error

```

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

### Empty Example Block

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/otelconf

An empty code block placeholder found in the package documentation.

```text
Output:

```

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

### RegisterTextMapPropagator Example

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/propagators/autoprop

Shows the output when using a custom registered propagator.

```go
Output:
[my-header-val]
```

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

### Create New Export Pipeline with Cortex Exporter

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/metric/cortex

Sets up a complete export pipeline including a push Controller and Exporter for Cortex. This is a convenient way to initialize a fully functional metric export setup.

```go
func NewExportPipeline(config Config, options ...controller.Option) (*controller.Controller, error)
```

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

### Trace Visualization Examples

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/examples/passthrough

Visual representations of expected trace behavior with and without passthrough configuration.

```text
|-------outer---------|
 |-Passthrough recv-|
  |Passthrough send|
    |---inner---|
```

```text
|-------outer---------|
    |---inner---|
```

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

### Initialize New SDK

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/otelconf

Creates SDK providers based on the configuration model, checking the OTEL_CONFIG_FILE environment variable.

```go
func NewSDK(opts ...ConfigurationOption) (SDK, error)
```

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

### Instrument Lambda Handler

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda/xrayconfig

Basic setup for a Lambda function using the otellambda package to instrument a handler.

```go
package main

import (
	"context"
	"fmt"
	"github.com/aws/aws-lambda-go/lambda"
	"go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda"
)

type MyEvent struct {
	Name string `json:"name"`
}

func HandleRequest(ctx context.Context, name MyEvent) (string, error) {
	return fmt.Sprintf("Hello %s!", name.Name ), nil
}

func main() {
	lambda.Start(otellambda.InstrumentHandler(HandleRequest))
}
```

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

### Initialize and Manage SDK

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/otelconf/x

SDK struct definition and methods for creating the SDK and accessing configured providers.

```go
type SDK struct {
	// contains filtered or unexported fields
}
```

```go
func NewSDK(opts ...ConfigurationOption) (SDK, error)
```

```go
func (s *SDK) LoggerProvider() log.LoggerProvider
```

```go
func (s *SDK) MeterProvider() metric.MeterProvider
```

```go
func (s *SDK) Propagator() propagation.TextMapPropagator
```

```go
func (s *SDK) Resource() *sdkresource.Resource
```

```go
func (s *SDK) Shutdown(ctx context.Context) error
```

```go
func (s *SDK) TracerProvider() trace.TracerProvider
```

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

### Carrier Get Method

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/propagators/envcar

Retrieves a value from the current process environment using a normalized key.

```go
func (*Carrier) Get(key string) string
```

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

### InstallNewPipeline

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/metric/dogstatsd

Installs a new export pipeline globally using the provided configuration. This function is typically called at the beginning of an application to set up metrics export.

```APIDOC
## InstallNewPipeline

### Description
Installs a NewExportPipeline and registers it globally. Typically called as:
```
pipeline, err := dogstatsd.InstallNewPipeline(dogstatsd.Config{...})
if err != nil {
	...
}
defer pipeline.Stop()
...
```

### Function Signature
```
func InstallNewPipeline(config Config) (*controller.Controller, error)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **controller.Controller**: A controller for managing the export pipeline.
- **error**: An error if the pipeline could not be installed.

#### Response Example
None
```

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

### Process Span on Start

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/zpages

Registers a span as active and reports it to zpages when it starts.

```go
func (ssm *SpanProcessor) OnStart(_ context.Context, span sdktrace.ReadWriteSpan)
```

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

### Run the Go application

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/examples/otel-collector

Executes the sample application that generates telemetry data.

```bash
go run main.go
```

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

### WithOpenTelemetryConfiguration Function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/config/v0.2.0

Creates a ConfigurationOption to set the OpenTelemetryConfiguration used to produce the SDK. This allows for detailed SDK setup.

```go
func WithOpenTelemetryConfiguration(cfg OpenTelemetryConfiguration) ConfigurationOption
```

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

### Get Operation

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/bradfitz/gomemcache

Invokes the memcache Get operation and traces its execution. Errors during the operation will be recorded in the trace span.

```go
func (c *Client) Get(key string) (*memcache.Item, error)
```

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

### Middleware

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux

Middleware sets up a handler to start tracing the incoming requests. The service parameter should describe the name of the (virtual) server handling the request.

```APIDOC
## Middleware

### Description

Middleware sets up a handler to start tracing the incoming requests. The service parameter should describe the name of the (virtual) server handling the request.

### Function Signature

```go
func Middleware(service string, opts ...Option) mux.MiddlewareFunc
```

### Parameters

- **service** (string) - The name of the (virtual) server handling the request.
- **opts** (...Option) - Optional configuration options for the middleware.
```

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

### Create and Load Cortex Configuration from YAML

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/metric/cortex/utils

Demonstrates how to create a custom HTTP client and use it to load a Cortex configuration from a YAML file, specifying search paths and the client. This is useful for customizing exporter settings.

```go
// Create a custom HTTP client.
client := http.DefaultClient

// Search for a YAML file named config.yml in "." and "./configs" and use it to create a
// Config struct with the provided HTTP client.
config, err := NewConfig("config.yml", WithFilepath("./configs"), WithClient(client))
if err != nil {
    // Handle error
}

// Use newly created Config struct!

```

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

### func NewSDK(opts ...ConfigurationOption) (SDK, error)

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/otelconf/v0.2.0

Initializes a new SDK instance using the provided configuration options.

```APIDOC
## func NewSDK

### Description
Creates and returns a new SDK instance configured with the specified options.

### Parameters
- **opts** (...ConfigurationOption) - Optional - A variadic list of configuration options to apply.

### Returns
- **(SDK, error)** - Returns the initialized SDK instance or an error if initialization fails.
```

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

### Initialize New Sampler

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/samplers/jaegerremote

Creates a new sampler that periodically pulls sampling strategies from an HTTP sampling server.

```go
func New(
	serviceName string,
	opts ...Option,
) *Sampler
```

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

### Go Runtime Metrics Overview

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/plugins/runtime

Lists the available Go runtime metrics provided by the package, including their names, units, and descriptions.

```Go
runtime.go.cgo.calls         -          Number of cgo calls made by the current process
runtime.go.gc.count          -          Number of completed garbage collection cycles
runtime.go.gc.pause_ns       (ns)       Amount of nanoseconds in GC stop-the-world pauses
runtime.go.gc.pause_total_ns (ns)       Cumulative nanoseconds in GC stop-the-world pauses since the program started
runtime.go.goroutines        -          Number of goroutines that currently exist
runtime.go.lookups           -          Number of pointer lookups performed by the runtime
runtime.go.mem.heap_alloc    (bytes)    Bytes of allocated heap objects
runtime.go.mem.heap_idle     (bytes)    Bytes in idle (unused) spans
runtime.go.mem.heap_inuse    (bytes)    Bytes in in-use spans
runtime.go.mem.heap_objects  -          Number of allocated heap objects
runtime.go.mem.heap_released (bytes)    Bytes of idle spans whose physical memory has been returned to the OS
runtime.go.mem.heap_sys      (bytes)    Bytes of heap memory obtained from the OS
runtime.go.mem.live_objects  -          Number of live objects is the number of cumulative Mallocs - Frees
runtime.uptime               (ms)       Milliseconds since application was initialized

```

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

### GetPkgNameFromUsesTable

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrgen/lib

Gets the package name from the uses table.

```APIDOC
## GetPkgNameFromUsesTable

### Description
GetPkgNameFromUsesTable gets package name from uses table.

### Signature
```go
func GetPkgNameFromUsesTable(pkg *packages.Package, ident *ast.Ident) string
```
```

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

### GetPkgNameFromDefsTable

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrgen/lib

Gets the package name from the definitions table.

```APIDOC
## GetPkgNameFromDefsTable

### Description
GetPkgNameFromDefsTable gets package name from uses table.

### Signature
```go
func GetPkgNameFromDefsTable(pkg *packages.Package, ident *ast.Ident) string
```
```

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

### Configure Jaeger Remote Sampler in Go

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/samplers/jaegerremote

Initialize the sampler with a service name and backend URL, then register it with the TracerProvider.

```go
	jaegerRemoteSampler := jaegerremote.New(
		"your-service-name",
		jaegerremote.WithSamplingServerURL("http://{sampling_service_host_name}:5778/sampling"),
		jaegerremote.WithSamplingRefreshInterval(10*time.Second),
		jaegerremote.WithInitialSampler(trace.TraceIDRatioBased(0.5)),
	)

	tp := trace.NewTracerProvider(
		trace.WithSampler(jaegerRemoteSampler),
		...
	)
	otel.SetTracerProvider(tp)
```

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

### Get SeverityVar value

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/processors/minsev

Retrieves the current severity level.

```go
func (v *SeverityVar) Severity() log.Severity
```

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

### Option Interface and Configuration

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-sdk-go-v2/otelaws

Interface and configuration functions for customizing the instrumentation behavior.

```go
type Option interface {
	// contains filtered or unexported methods
}
```

```go
func WithAttributeBuilder(attributeBuilders ...AttributeBuilder) Option
```

```go
func WithTextMapPropagator(propagator propagation.TextMapPropagator) Option
```

```go
func WithTracerProvider(provider trace.TracerProvider) Option
```

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

### Stop the instrumentation example

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-lambda-go/otellambda/example

Shuts down the Docker containers and cleans up resources.

```bash
docker-compose down
```

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

### Shutdown infrastructure

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/examples/otel-collector

Stops and removes the Docker containers used for the example.

```bash
docker compose down
```

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

### Initialize LogSink

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/bridges/otellogr

Creates a new LogSink instance. Uses the global LoggerProvider if none is specified via options.

```go
func NewLogSink(name string, options ...Option) *LogSink
```

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

### Get HelloRequest Greeting

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc/example/api

Accessor method for the greeting field in HelloRequest.

```go
func (x *HelloRequest) GetGreeting() string
```

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

### Configure SDK options

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/otelconf/x

Interface and helper function for configuring SDK providers.

```go
type ConfigurationOption interface {
	// contains filtered or unexported methods
}
```

```go
func WithContext(ctx context.Context) ConfigurationOption
```

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

### NewSDK Function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/config/v0.2.0

Creates SDK providers based on the provided configuration options.

```go
func NewSDK(opts ...ConfigurationOption) (SDK, error)
```

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

### GetPkgNameFromUsesTable Function Signature

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrgen/lib

Gets the package name from the uses table.

```go
func GetPkgNameFromUsesTable(pkg *packages.Package, ident *ast.Ident) string
```

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

### GetPkgNameFromDefsTable Function Signature

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrgen/lib

Gets the package name from the definitions table.

```go
func GetPkgNameFromDefsTable(pkg *packages.Package, ident *ast.Ident) string
```

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

### Stop Zipkin Services

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/examples/zipkin

Shut down the zipkin-collector and zipkin-client services when you are finished with the example.

```bash
docker-compose down

```

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

### Get HelloRequest ProtoReflect

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc/example/api

Method to access the protocol buffer reflection interface.

```go
func (x *HelloRequest) ProtoReflect() protoreflect.Message
```

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

### ProducerMessageCarrier Get Method

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/Shopify/sarama

Retrieves a single value for a given key from the ProducerMessageCarrier.

```go
func (c ProducerMessageCarrier) Get(key string) string
```

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

### Get Template Name Attribute

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/astaxie/beego/otelbeego

Returns the template name as a KeyValue pair.

```go
func Template(name string) attribute.KeyValue
```

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

### ConfigurationOption Interface

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/config/v0.3.0

An interface for configuring SDK provider options.

```go
type ConfigurationOption interface {
	// contains filtered or unexported methods
}

```

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

### ConsumerMessageCarrier Get Method

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/Shopify/sarama

Retrieves a single value for a given key from the ConsumerMessageCarrier.

```go
func (c ConsumerMessageCarrier) Get(key string) string
```

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

### Initialize Lambda Resource Detector

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/detectors/aws/lambda

Create a resource detector instance and use it to configure the TracerProvider within a Lambda handler.

```go
package main

import (
	"github.com/aws/aws-lambda-go/lambda"
	sdktrace "go.opencensus.io/otel/sdk/trace"
	lambdadetector "go.opentelemetry.io/contrib/detectors/aws/lambda"
)

func main() {
	detector := lambdadetector.NewResourceDetector()
	res, err := detector.Detect(context.Background())
	if err != nil {
		fmt.Printf("failed to detect lambda resources: %v\n", err)
	}

	tp := sdktrace.NewTracerProvider(
		sdktrace.WithResource(res),
	)
	lambda.Start(<some lambda handler>)
}
```

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

### func ServicePrefix

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc/filters

Returns a Filter that matches if the service name starts with the provided prefix.

```APIDOC
## func ServicePrefix(pre string) otelgrpc.Filter

### Description
Returns a Filter that returns true if the request's service name (e.g., package.service) starts with the provided string pre.
```

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

### NewSDK

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/otelconf/x

Creates SDK providers based on the configuration model, checking the local environment and the file specified by OTEL_EXPERIMENTAL_CONFIG_FILE.

```APIDOC
## func NewSDK(opts ...ConfigurationOption) (SDK, error)

### Description
Creates SDK providers based on the configuration model. It checks the local environment and uses the file set in the variable OTEL_EXPERIMENTAL_CONFIG_FILE to configure the SDK automatically.

### Parameters
- **opts** (...ConfigurationOption) - Optional - Configuration options for the SDK.
```

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

### func MethodPrefix

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc/filters

Returns a Filter that matches if the method name starts with the provided prefix.

```APIDOC
## func MethodPrefix(pre string) otelgrpc.Filter

### Description
Returns a Filter that returns true if the request's method starts with the provided string pre.
```

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

### Initialize New Hook

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/bridges/otellogrus

Creates a new Hook instance. Uses the global LoggerProvider if none is specified via options.

```go
func NewHook(name string, options ...Option) *Hook
```

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

### Get Propagator Fields

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/propagators/aws/xray

Returns the list of fields used by the propagator for header propagation.

```go
func (Propagator) Fields() []string
```

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

### Define SDK configuration functions

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/otelconf/v0.2.0

Functions for setting context and OpenTelemetry configuration.

```go
func WithContext(ctx context.Context) ConfigurationOption
```

```go
func WithOpenTelemetryConfiguration(cfg OpenTelemetryConfiguration) ConfigurationOption
```

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

### Kafka Topic Constant

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/Shopify/sarama/example

Defines the Kafka topic name used for the Sarama instrumentation example.

```go
const (
	KafkaTopic = "sarama-instrumentation-example"
)

```

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

### Initialize LogSink Runtime

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/bridges/otellogr

Receives runtime information from the logr library.

```go
func (*LogSink) Init(logr.RuntimeInfo)
```

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

### Create New HTTP Client Trace

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/httptrace

Initializes a new httptrace.ClientTrace for instrumenting HTTP client requests.

```go
func NewClientTrace(ctx context.Context) *httptrace.ClientTrace
```

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

### Metric Export Success/Failure Example

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/metric/cortex

Illustrates how cumulative metrics are preserved even if some exports fail.

```text
  SUCCESS FAIL FAIL SUCCESS SUCCESS
  1       2    3    4       5

```

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

### Shut Down Docker Compose

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/metric/cortex/example

Stops and removes the Docker services used in the Cortex exporter example.

```bash
docker-compose down
```

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

### func NewSDK(opts ...ConfigurationOption) (SDK, error)

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/otelconf/v0.3.0

Initializes a new OpenTelemetry SDK instance using the provided configuration options.

```APIDOC
## func NewSDK

### Description
Creates and returns a new SDK instance configured with the specified options.

### Parameters
- **opts** (...ConfigurationOption) - Optional - A variadic list of configuration options.

### Returns
- **(SDK, error)** - The initialized SDK instance or an error.
```

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

### WithFilesystem

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/metric/cortex/utils

Creates an Option to specify the filesystem for Viper to search for the YAML configuration file.

```APIDOC
## WithFilesystem

### Description
WithFilesystem tells Viper which file system to search for the YAML file in. By default, Viper will search the OS file system, but users can pass in an in-memory filesystem for testing.

### Signature
```go
func WithFilesystem(fs afero.Fs) Option
```

### Parameters
#### Path Parameters
- **fs** (afero.Fs) - Required - The filesystem to use for searching the configuration file.

### Returns
- **Option** - An Option that configures the filesystem.
```

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

### PathPrefix filter function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp/filters

Returns a filter that checks if the request path starts with the provided string.

```go
func PathPrefix(p string) otelhttp.Filter
```

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

### OnEnd Implementation for BaggageTrace SpanProcessor

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/processors/baggage/baggagetrace

The OnEnd method is a no-op for this processor, as it only acts on span start.

```go
func (processor SpanProcessor) OnEnd(s trace.ReadOnlySpan)
```

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

### HelloService_SayHelloBidiStreamServer Interface

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/example/api

Server-side interface for bidirectional streaming in SayHelloBidiStream.

```go
type HelloService_SayHelloBidiStreamServer interface {
	Send(*HelloResponse) error
	Recv() (*HelloRequest, error)
	grpc.ServerStream
}

```

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

### func Middleware

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/gorilla/mux/otelmux

Middleware sets up a handler to start tracing incoming requests for a gorilla/mux router.

```APIDOC
## func Middleware(service string, opts ...Option) mux.MiddlewareFunc

### Description
Middleware sets up a handler to start tracing the incoming requests. The service parameter should describe the name of the (virtual) server handling the request.

### Parameters
- **service** (string) - Required - The name of the server handling the request.
- **opts** (...Option) - Optional - Configuration options for the instrumentation.
```

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

### WithContext Function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/config/v0.3.0

Creates a ConfigurationOption to set the context.Context for the SDK.

```go
func WithContext(ctx context.Context) ConfigurationOption

```

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

### MethodPrefix filter function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc/filters

Returns a filter that matches if the request method starts with the provided prefix.

```go
func MethodPrefix(pre string) otelgrpc.Filter
```

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

### SDK Provider and Resource Methods

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/otelconf/v0.3.0

Methods for accessing configured providers and managing SDK lifecycle and resources.

```go
func (s *SDK) MeterProvider() metric.MeterProvider
```

```go
func (s *SDK) Resource() *sdkresource.Resource
```

```go
func (s *SDK) Shutdown(ctx context.Context) error
```

```go
func (s *SDK) TracerProvider() trace.TracerProvider
```

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

### Get Jaeger Header Fields

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/propagators/jaeger

Returns the list of header keys used by the Jaeger propagator.

```go
func (Jaeger) Fields() []string
```

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

### Create Cortex Exporter Config

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/metric/cortex

Demonstrates two methods for creating a Cortex exporter configuration: using the utils module to load from a YAML file or creating the struct manually. The Validate() method is crucial for manual configuration.

```go
// (Option 1) Create Config struct using utils module.
config, err := utils.NewConfig("config.yml")
if err != nil {
    return err
}

// (Option 2) Create Config struct manually.
configTwo := cortex.Config {
  Endpoint:      "http://localhost:9009/api/prom/push",
	RemoteTimeout: 30 * time.Second,
	PushInterval: 5 * time.Second,
	Headers: map[string]string{
		"test": "header",
	},
}
// Validate() should be called when creating the Config struct manually.
err = config.Validate()
if err != nil {
	return err
}

```

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

### WithSpanStartOptions

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/gin-gonic/gin/otelgin

Configures additional trace.SpanStartOptions.

```APIDOC
## func WithSpanStartOptions(opts ...oteltrace.SpanStartOption) Option

### Description
Configures an additional set of trace.SpanStartOptions, which are applied to each new span.
```

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

### Core Configuration Options

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/bridges/otelzap

Functional options for configuring the otelzap Core.

```go
func WithAttributes(attributes ...attribute.KeyValue) Option
```

```go
func WithLoggerProvider(provider log.LoggerProvider) Option
```

```go
func WithSchemaURL(schemaURL string) Option
```

```go
func WithVersion(version string) Option
```

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

### Get Module Version

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc/test

Retrieves the current release version of the gRPC instrumentation test module.

```go
func Version() string
```

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

### Get DogStatsD Attribute Encoder ID

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/metric/dogstatsd

Returns the unique identifier for the DogStatsD attribute encoder.

```go
func (*AttributeEncoder) ID() attribute.EncoderID
```

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

### Entry Point Instrumentation Call

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrgen

Add this call in your main function to enable automatic instrumentation.

```go
func main() {
    rtlib.AutotelEntryPoint()


```

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

### NewCore Constructor

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/bridges/otelzap

Creates a new zapcore.Core for use with zap.New. The name parameter should be the package import path.

```go
func NewCore(name string, opts ...Option) *Core
```

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

### Configure Inject Encoding

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/propagators/b3

Example of configuring the propagator to inject both single and multiple B3 headers simultaneously.

```go
WithInjectEncoding(B3SingleHeader | B3MultipleHeader)
```

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

### NewSDK

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/otelconf

Creates SDK providers based on the configuration model, automatically checking the environment and the OTEL_CONFIG_FILE variable.

```APIDOC
## func NewSDK(opts ...ConfigurationOption) (SDK, error)

### Description
Creates SDK providers based on the configuration model. It checks the local environment and uses the file set in the variable `OTEL_CONFIG_FILE` to configure the SDK automatically.

### Parameters
- **opts** (...ConfigurationOption) - Optional - Configuration options to apply to the SDK.

### Returns
- **SDK** - The configured SDK instance.
- **error** - An error if initialization fails.
```

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

### Define Kafka Topic Constant

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/Shopify/sarama/otelsarama/example

Defines the Kafka topic name used for the Sarama instrumentation example.

```go
const (
	// KafkaTopic name.
	KafkaTopic = "sarama-instrumentation-example"
)

```

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

### WithContext Function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/config/v0.2.0

Creates a ConfigurationOption to set the context.Context for the SDK. Use this to pass request-scoped values, cancellation signals, and deadlines.

```go
func WithContext(ctx context.Context) ConfigurationOption
```

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

### GetMostInnerAstIdent

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrgen/lib

Takes the most inner identifier used for a function call. For example, in `a.b.foo()`, `b` will be the most inner identifier.

```APIDOC
## GetMostInnerAstIdent

### Description
GetMostInnerAstIdent takes most inner identifier used for function call. For a.b.foo(), `b` will be the most inner identifier.

### Signature
```go
func GetMostInnerAstIdent(inSel *ast.SelectorExpr) *ast.Ident
```
```

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

### PackageAnalysis Execute Method

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrgen/lib

The main entry point for the analysis process, executing a specified analysis pass.

```go
func (analysis *PackageAnalysis) Execute(pass FileAnalysisPass, fileSuffix string) ([]*ast.File, error)
```

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

### Run OpenTelemetry Collector with Docker Compose

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/samplers/jaegerremote

Start the OpenTelemetry Collector using the provided docker-compose configuration.

```bash
docker-compose up -d
```

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

### PathPrefix

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/net/http/filters

PathPrefix returns a Filter that returns true if the request's path starts with the provided string.

```APIDOC
## PathPrefix

### Description
PathPrefix returns a Filter that returns true if the request's path starts with the provided string.

### Signature
```go
func PathPrefix(p string) otelhttp.Filter
```
```

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

### func FullMethodName

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc/filters

Returns a Filter that matches if the full RPC method string starts with the provided string.

```APIDOC
## func FullMethodName(n string) otelgrpc.Filter

### Description
Returns a Filter that returns true if the request's full RPC method string (e.g., /package.service/method) starts with the provided string n.
```

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

### Configure MeterProvider Options

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/otelconf/v0.3.0

Appends metric options for constructing a MeterProvider, where OpenTelemetryConfiguration takes precedence.

```go
func WithMeterProviderOptions(opts ...sdkmetric.Option) ConfigurationOption
```

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

### ServicePrefix filter function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc/filters

Returns a filter that matches if the request service name starts with the provided prefix.

```go
func ServicePrefix(pre string) otelgrpc.Filter
```

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

### Configuration Option Functions

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/otelconf

Functional options for configuring SDK providers and context.

```go
func WithContext(ctx context.Context) ConfigurationOption
```

```go
func WithLoggerProviderOptions(opts ...sdklog.LoggerProviderOption) ConfigurationOption
```

```go
func WithMeterProviderOptions(opts ...sdkmetric.Option) ConfigurationOption
```

```go
func WithOpenTelemetryConfiguration(cfg OpenTelemetryConfiguration) ConfigurationOption
```

```go
func WithTracerProviderOptions(opts ...sdktrace.TracerProviderOption) ConfigurationOption
```

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

### Define ExperimentalPeerInstrumentation

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/otelconf/x

Defines the structure for configuring service mappings based on peer semantic conventions.

```go
type ExperimentalPeerInstrumentation struct {
	// Configure the service mapping for instrumentations following peer.service
	// semantic conventions.
	// See peer.service semantic conventions:
	// https://opentelemetry.io/docs/specs/semconv/general/attributes/#general-remote-service-attributes
	// If omitted, no peer service mappings are used.
	//
	ServiceMapping []ExperimentalPeerServiceMapping `json:"service_mapping,omitempty,omitzero" yaml:"service_mapping,omitempty" mapstructure:"service_mapping,omitempty"`
}
```

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

### Create New Metric Reader

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/autoexport

Returns a configured metric reader based on environment variables.

```go
func NewMetricReader(ctx context.Context, opts ...MetricOption) (metric.Reader, error)
```

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

### Get Template Name as KeyValue

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/astaxie/beego

Returns the template name as a KeyValue pair for use in OpenTelemetry labels.

```go
func Template(name string) label.KeyValue
```

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

### Create DogStatsD Export Pipeline

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/metric/dogstatsd

Sets up a complete export pipeline with recommended components, chaining a NewRawExporter into selectors and batchers.

```go
func NewExportPipeline(config Config, opts ...controller.Option) (*controller.Controller, error)
```

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

### NewExportPipeline

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/metric/dogstatsd

Creates a new export pipeline with a recommended setup, chaining a raw exporter with selectors and batchers.

```APIDOC
## NewExportPipeline

### Description
Sets up a complete export pipeline with the recommended setup, chaining a NewRawExporter into the recommended selectors and batchers.

### Function Signature
```
func NewExportPipeline(config Config, opts ...controller.Option) (*controller.Controller, error)
```

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **controller.Controller**: A controller for managing the export pipeline.
- **error**: An error if the pipeline could not be created.

#### Response Example
None
```

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

### Core Method Implementations

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/bridges/otelzap

Methods for managing the lifecycle and behavior of the otelzap Core.

```go
func (o *Core) Check(ent zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry
```

```go
func (o *Core) Enabled(level zapcore.Level) bool
```

```go
func (*Core) Sync() error
```

```go
func (*Core) With(fields []zapcore.Field) zapcore.Core
```

```go
func (*Core) Write(ent zapcore.Entry, fields []zapcore.Field) error
```

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

### NewResource Function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrgen/rtlib

Generates a resource that describes the current application.

```go
func NewResource() *resource.Resource {
}
```

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

### func SubOperation

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/examples/namedtracer/foo

SubOperation is an example function that demonstrates the use of a named tracer by creating one with the package path.

```APIDOC
## func SubOperation

### Description
SubOperation is an example to demonstrate the use of a named tracer. It creates a named tracer with its package path.

### Signature
`func SubOperation(ctx context.Context) error`

### Parameters
- **ctx** (context.Context) - The context for the operation.

### Returns
- **error** - Returns an error if the operation fails, otherwise nil.
```

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

### NewHelloServiceClient

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/example/api

Creates a new HelloServiceClient.

```APIDOC
## NewHelloServiceClient

### Description
Creates a new HelloServiceClient.

### Parameters
- **cc** (*grpc.ClientConn) - The client connection to use.
```

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

### FullMethodName filter function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc/filters

Returns a filter that matches if the full RPC method string starts with the provided string.

```go
func FullMethodName(n string) otelgrpc.Filter
```

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

### Initialize Tracer Function

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/Shopify/sarama/example

Placeholder function for initializing the tracer. Actual implementation would configure the OpenTelemetry tracer.

```go
func InitTracer() {
}

```

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

### Deploy OpenTelemetry Collector infrastructure

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/examples/otel-collector

Starts the OpenTelemetry Collector, Jaeger, and Prometheus services using Docker Compose.

```bash
docker compose up -d
```

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

### Create Fallback Sampler

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/samplers/aws/xray

Instantiates a FallbackSampler that samples 1 request per second and an additional 5% of requests using a traceIDRatioBasedSampler.

```go
func NewFallbackSampler() *FallbackSampler
```

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

### SpanProcessor Implementation

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/processors/baggagecopy

SpanProcessor adds baggage members as attributes to spans when they start. Use NewSpanProcessor to initialize it with a specific filter.

```go
type SpanProcessor struct {
	// contains filtered or unexported fields
}
```

```go
func NewSpanProcessor(filter Filter) *SpanProcessor
```

```go
func (SpanProcessor) ForceFlush(context.Context) error
```

```go
func (SpanProcessor) OnEnd(trace.ReadOnlySpan)
```

```go
func (processor SpanProcessor) OnStart(ctx context.Context, span trace.ReadWriteSpan)
```

```go
func (SpanProcessor) Shutdown(context.Context) error
```

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

### Initialize Producer

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/runtime

Creates a new Producer instance for runtime metrics.

```go
func NewProducer(opts ...ProducerOption) *Producer
```

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

### Enable Tracing with NewSessionWithTracing

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql

Use `NewSessionWithTracing` to create a new gocql session with tracing enabled for queries, batch queries, and connection attempts. You can pass additional options to customize the instrumentation.

```go
package main

import (
	"context"

	"github.com/gocql/gocql"
	otelGocql "go.opentelemetry.io/contrib/instrumentation/github.com/gocql/gocql"
)

func main() {
	// Create a cluster
	host := "localhost"
	cluster := gocql.NewCluster(host)

	// Create a session with tracing
	session, err := otelGocql.NewSessionWithTracing(
		context.Background(),
		cluster,
		// Include any options here
	)

	// Begin using the session

}
```

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

### type Carrier

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/propagators/envcar

Carrier is a propagation.TextMapCarrier for environment variables. It provides methods to Get, Set, and list Keys for context propagation.

```APIDOC
## func (*Carrier) Get(key string) string

### Description
Normalizes the provided key and returns the corresponding value from the current process environment. Returns an empty string if the variable is unset or empty.

## func (*Carrier) Keys() []string

### Description
Returns a slice of normalized environment variable names currently present in the process.

## func (*Carrier) Set(key, value string)

### Description
Stores a key-value pair by calling the configured SetEnvFunc. The key is normalized before the function is invoked. If SetEnvFunc is nil, this method performs no action.
```

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

### HelloService_SayHelloClientStreamServer Interface

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/example/api

Server-side interface for client-side streaming in SayHelloClientStream.

```go
type HelloService_SayHelloClientStreamServer interface {
	SendAndClose(*HelloResponse) error
	Recv() (*HelloRequest, error)
	grpc.ServerStream
}

```

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

### Configure Endpoint Middleware with Operation Name Getter

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/go-kit/kit/otelkit

Option to set a function for dynamically getting the operation name in the configuration.

```go
func WithOperationGetter(fn func(ctx context.Context, name string) string) Option
```

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

### HelloServiceServer Interface

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/example/api

Defines the server interface for the Hello service, including methods for SayHello and various streaming operations.

```go
type HelloServiceServer interface {
	SayHello(context.Context, *HelloRequest) (*HelloResponse, error)
	SayHelloServerStream(*HelloRequest, HelloService_SayHelloServerStreamServer) error
	SayHelloClientStream(HelloService_SayHelloClientStreamServer) error
	SayHelloBidiStream(HelloService_SayHelloBidiStreamServer) error
}

```

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

### Client Methods

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/instrumentation/github.com/bradfitz/gomemcache/memcache/otelmemcache

The Client type provides methods that mirror the original memcache client's API, each of which starts a span for the operation.

```APIDOC
## Client Methods

### Description
The Client type provides methods that mirror the original memcache client's API, each of which starts a span for the operation.

### Methods

#### Add
```
func (c *Client) Add(item *memcache.Item) error
```
Invokes the add operation and traces it.

#### CompareAndSwap
```
func (c *Client) CompareAndSwap(item *memcache.Item) error
```
Invokes the compare-and-swap operation and traces it.

#### Decrement
```
func (c *Client) Decrement(key string, delta uint64) (uint64, error)
```
Invokes the decrement operation and traces it.

#### Delete
```
func (c *Client) Delete(key string) error
```
Invokes the delete operation and traces it.

#### DeleteAll
```
func (c *Client) DeleteAll() error
```
Invokes the delete all operation and traces it.

#### FlushAll
```
func (c *Client) FlushAll() error
```
Invokes the flush all operation and traces it.

#### Get
```
func (c *Client) Get(key string) (*memcache.Item, error)
```
Invokes the get operation and traces it.

#### GetMulti
```
func (c *Client) GetMulti(keys []string) (map[string]*memcache.Item, error)
```
Invokes the get operation for multiple keys and traces it.

#### Increment
```
func (c *Client) Increment(key string, delta uint64) (uint64, error)
```
Invokes the increment operation and traces it.

#### Ping
```
func (c *Client) Ping() error
```
Invokes the ping operation and traces it.

#### Replace
```
func (c *Client) Replace(item *memcache.Item) error
```
Invokes the replace operation and traces it.

#### Set
```
func (c *Client) Set(item *memcache.Item) error
```
Invokes the set operation and traces it.

#### Touch
```
func (c *Client) Touch(key string, seconds int32) error
```
Invokes the touch operation and traces it.

#### WithContext
```
func (c *Client) WithContext(ctx context.Context) *Client
```
Returns a new client with the given context. This can be used to set context-specific options for subsequent operations.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- ***Client** (pointer to Client) - A new client with the context set.

#### Response Example
None
```

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

### Manage Sampler Lifecycle and Operations

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/samplers/jaegerremote

Methods for closing the sampler, retrieving its description, performing sampling, and manually updating strategies.

```go
func (s *Sampler) Close()
```

```go
func (*Sampler) Description() string
```

```go
func (s *Sampler) ShouldSample(p trace.SamplingParameters) trace.SamplingResult
```

```go
func (s *Sampler) UpdateSampler()
```

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

### Get Temporality for Metrics

Source: https://pkg.go.dev/go.opentelemetry.io/contrib/exporters/metric/cortex

Returns CumulativeExporter so the Processor correctly aggregates data. This is used to manage how metric data is aggregated over time.

```go
func (e *Exporter) TemporalityFor(*sdkapi.Descriptor, aggregation.Kind) aggregation.Temporality
```
Tokens:
Raw