e11y: An event-oriented observability library

[ apache, library, observability ] [ Propose Tags ]

Instrument your Haskell codebase with wide, semantically meaningful events.

This library is designed with separating the following concerns in mind:

Writing instrumentation
When instrumenting code, I want to think in terms of my application domain and report any information I might need in order to infer internal application-level state and understand the behavior of my program/library.
Consuming instrumentation
When consuming instrumentation, I want to think in terms of the API of the specific backend I'm supporting (writing to stderr, serving a Prometheus page, posting to OpenTelemetry) and what is needed to render to that API.
Initializing instrumentation in an application
When I'm ready to tie it all together, I want to identify the specific backends I want to post to and provide the bridge code to render the domain-specific instrumentation as needed for those backends. I also want to handle concerns like sampling or client-side aggregation of domain-specific instrumentation to keep usage manageable.

See Observe.Event for detailed documentation on instrumenting your code.

See Observe.Event.Backend for creating a new EventBackend to consume instrumentation.

See Observe.Event.Backend.Data for an EventBackend that represents the stream of events as ordinary Haskell data.

See e11y-otel for an OpenTelemetry-based backend.

This is a rewrite of eventuo11y, designed to be easier to use, less intrusive, and not nearly as annoying to write/say. The name is a shortening of "event-based observability" (event-based -> e, observability -> o11y), and can be pronounced "eh-lee" or "ee-eleven-why".

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0
Change log CHANGELOG.md
Dependencies base (>=4.16 && <4.20), containers (>=0.6 && <0.8), general-allocate (>=0.2.3 && <0.3), parametric-functor (>=0.1.1 && <0.2), primitive (>=0.9 && <0.10), transformers (>=0.5 && <0.7) [details]
License Apache-2.0
Copyright Copyright 2024 Shea Levy Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Author Shea Levy
Maintainer shea@shealevy.com
Category Observability
Home page https://github.com/shlevy/e11y
Bug tracker https://github.com/shlevy/e11y/issues
Source repo head: git clone https://github.com/shlevy/e11y
Uploaded by shlevy at 2024-01-16T22:58:24Z
Distributions
Reverse Dependencies 1 direct, 0 indirect [details]
Downloads 32 total (6 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2024-01-16 [all 1 reports]