...

Source file src/go.opentelemetry.io/otel/sdk/resource/doc.go

Documentation: go.opentelemetry.io/otel/sdk/resource

     1  // Copyright The OpenTelemetry Authors
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Package resource provides detecting and representing resources.
    16  //
    17  // The fundamental struct is a Resource which holds identifying information
    18  // about the entities for which telemetry is exported.
    19  //
    20  // To automatically construct Resources from an environment a Detector
    21  // interface is defined. Implementations of this interface can be passed to
    22  // the Detect function to generate a Resource from the merged information.
    23  //
    24  // To load a user defined Resource from the environment variable
    25  // OTEL_RESOURCE_ATTRIBUTES the FromEnv Detector can be used. It will interpret
    26  // the value as a list of comma delimited key/value pairs
    27  // (e.g. `<key1>=<value1>,<key2>=<value2>,...`).
    28  //
    29  // While this package provides a stable API,
    30  // the attributes added by resource detectors may change.
    31  package resource // import "go.opentelemetry.io/otel/sdk/resource"
    32  

View as plain text