hs-opentelemetry-api: OpenTelemetry API. Intended for use by libraries for direct instrumentation or wrapper packages.

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Warnings:

The 'synopsis' field is rather long (max 80 chars is recommended).
The 'description' field should be longer than the 'synopsis' field. It's useful to provide an informative 'description' to allow Haskell programmers who have never heard about your package to understand the purpose of your package. The 'description' field content is typically shown by tooling (e.g. 'cabal info', Haddock, Hackage) below the 'synopsis' which serves as a headline. Please refer to <https://www.haskell.org/cabal/users-guide/developing-packages.html#package-properties> for more details.

Please see the README on GitHub at https://github.com/iand675/hs-opentelemetry-api#readme

[Skip to Readme]

Properties

Versions	0.0.1.0, 0.0.2.0, 0.0.3.0, 0.0.3.1, 0.0.3.2, 0.0.3.3, 0.0.3.4, 0.0.3.5, 0.0.3.6, 0.0.3.7, 0.0.3.8, 0.1.0.0, 0.1.0.0
Change log	ChangeLog.md
Dependencies	async, attoparsec, base (>=4.7 && <5), binary, bytestring, charset, clock, ghc-prim, hashable, http-types, memory, microlens, mtl, mwc-random, network-bsd, random, random-bytestring, template-haskell, text, thread-utils-context, unix, unliftio-core, unordered-containers, vault, vector, vector-builder [details]
License	BSD-3-Clause
Copyright	2021 Ian Duncan
Author	Ian Duncan
Maintainer	ian@iankduncan.com
Category	OpenTelemetry, Telemetry, Monitoring, Observability, Metrics
Home page	https://github.com/iand675/hs-opentelemetry#readme
Bug tracker	https://github.com/iand675/hs-opentelemetry/issues
Source repo	head: git clone https://github.com/iand675/hs-opentelemetry
Uploaded	by IanDuncan at 2021-11-27T22:06:07Z

Modules

OpenTelemetry
- OpenTelemetry.Baggage
- OpenTelemetry.Context
  - OpenTelemetry.Context.Propagators
  - OpenTelemetry.Context.ThreadLocal
- OpenTelemetry.Resource
  - OpenTelemetry.Resource.Cloud
  - OpenTelemetry.Resource.Container
  - OpenTelemetry.Resource.DeploymentEnvironment
  - OpenTelemetry.Resource.Device
  - OpenTelemetry.Resource.FaaS
  - OpenTelemetry.Resource.Host
  - OpenTelemetry.Resource.Kubernetes
  - OpenTelemetry.Resource.OperatingSystem
  - OpenTelemetry.Resource.Process
  - OpenTelemetry.Resource.Service
  - OpenTelemetry.Resource.Telemetry
  - OpenTelemetry.Resource.Webengine
- OpenTelemetry.Trace
  - OpenTelemetry.Trace.Id
  - OpenTelemetry.Trace.IdGenerator
  - OpenTelemetry.Trace.Monad
  - OpenTelemetry.Trace.Sampler
  - OpenTelemetry.Trace.SpanExporter
  - OpenTelemetry.Trace.SpanProcessor
  - OpenTelemetry.Trace.TraceState
- OpenTelemetry.Util

Downloads

hs-opentelemetry-api-0.1.0.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

IanDuncan

For package maintainers and hackage trustees

edit package information

Readme for hs-opentelemetry-api-0.1.0.0

[back to package description]

OpenTelemetry API for Haskell

The inspiration of the OpenTelemetry project is to make every library and application observable out of the box by having them call the OpenTelemetry API directly. Until that happens, there is a need for a separate library which can inject this information. A library that enables observability for another library is called an instrumentation library. In the case of Haskell, instrumentation is currently entirely manual.

This package provides everything needed to interact with the OpenTelemetry API.

The methods in this package can be safely called by library or end-user application regardless of whether the application has registered an OpenTelemetry SDK configuration or not.

In order to generate and export telemetry data, you will also need to use the OpenTelemetry Haskell SDK.

Tracing Quick Start

You Will Need

An application you wish to instrument
OpenTelemetry Haskell SDK

Note for library authors: Only your end users will need an OpenTelemetry SDK. If you wish to support OpenTelemetry in your library, you only need to use the OpenTelemetry API. For more information, please read the [tracing documentation][docs-tracing].

Install Dependencies

Add otel-api to your package.yaml or Cabal file.

Trace Your Code

Useful Links

For more information on OpenTelemetry, visit: https://opentelemetry.io/
For more about OpenTelemetry Haskell: https://github.com/iand675/hs-opentelemetry