doc.go 1.6 KB

12345678910111213141516171819202122232425262728293031323334353637
  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 otel provides global access to the OpenTelemetry API. The subpackages of
  16. the otel package provide an implementation of the OpenTelemetry API.
  17. This package is currently in a Release Candidate phase. Backwards incompatible changes
  18. may be introduced prior to v1.0.0, but we believe the current API is ready to stabilize.
  19. The provided API is used to instrument code and measure data about that code's
  20. performance and operation. The measured data, by default, is not processed or
  21. transmitted anywhere. An implementation of the OpenTelemetry SDK, like the
  22. default SDK implementation (go.opentelemetry.io/otel/sdk), and associated
  23. exporters are used to process and transport this data.
  24. To read the getting started guide, see https://opentelemetry.io/docs/go/getting-started/.
  25. To read more about tracing, see go.opentelemetry.io/otel/trace.
  26. To read more about metrics, see go.opentelemetry.io/otel/metric.
  27. To read more about propagation, see go.opentelemetry.io/otel/propagation and
  28. go.opentelemetry.io/otel/baggage.
  29. */
  30. package otel // import "go.opentelemetry.io/otel"