README
¶
helix.go
helix.go is the Go implementation of helix, for building cloud-native, consistent, reliable, and high-performance (micro) services. It allows back-end engineers to simplify development of complex problems through a thin layer of abstraction that handles automatic logging, tracing, observability, and event propagation across services and integrations.
License
Repository licensed under the MIT License.
Documentation
¶
Overview ¶
Package helix is the top-level package for building helix services in Go.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package errorstack exposes a set of utilities for consistent error handling in the helix ecosystem.
|
Package errorstack exposes a set of utilities for consistent error handling in the helix ecosystem. |
|
Package event exposes some objects and utilities to get/set contextual information about an event.
|
Package event exposes some objects and utilities to get/set contextual information about an event. |
|
Package integration exposes the requirements that an integration must meet to be compatible with the helix.go ecosystem.
|
Package integration exposes the requirements that an integration must meet to be compatible with the helix.go ecosystem. |
|
bucket
Module
|
|
|
clickhouse
Module
|
|
|
nats
Module
|
|
|
openfeature
Module
|
|
|
postgres
Module
|
|
|
rest
Module
|
|
|
temporal
Module
|
|
|
vault
Module
|
|
|
internal
|
|
|
contextkey
Package contextkey holds the Go context keys used in helix.go.
|
Package contextkey holds the Go context keys used in helix.go. |
|
logger
Package logger initializes and exposes the global logger client used in the service and across integrations.
|
Package logger initializes and exposes the global logger client used in the service and across integrations. |
|
orchestrator
Package orchestrator allows each orchestrator to set consistent logs' fields and traces' attributes for OpenTelemetry.
|
Package orchestrator allows each orchestrator to set consistent logs' fields and traces' attributes for OpenTelemetry. |
|
orchestrator/kubernetes
Package kubernetes provides a helper to detect if the service is being run by Kubernetes, as well as utilities for consistent OpenTelemetry logs and traces.
|
Package kubernetes provides a helper to detect if the service is being run by Kubernetes, as well as utilities for consistent OpenTelemetry logs and traces. |
|
orchestrator/nomad
Package nomad provides a helper to detect if the service is being run by Nomad, as well as utilities for consistent OpenTelemetry logs and traces.
|
Package nomad provides a helper to detect if the service is being run by Nomad, as well as utilities for consistent OpenTelemetry logs and traces. |
|
orchestrator/unknown
Package unknown provides a fallback helper in case no orchestrator has been detected, as well as utilities for consistent OpenTelemetry logs and traces when not running within a known orchestrator.
|
Package unknown provides a fallback helper in case no orchestrator has been detected, as well as utilities for consistent OpenTelemetry logs and traces when not running within a known orchestrator. |
|
setup
Package setup ensures helix.go global environment is properly setup.
|
Package setup ensures helix.go global environment is properly setup. |
|
tracer
Package tracer initializes and exposes the global tracer exporter used in the service and across integrations.
|
Package tracer initializes and exposes the global tracer exporter used in the service and across integrations. |
|
Package service allows to manage a service leveraging helix.go, as well as managing integrations' lifecycle attached to the service.
|
Package service allows to manage a service leveraging helix.go, as well as managing integrations' lifecycle attached to the service. |
|
telemetry
|
|
|
log
Package log gives access to the global OpenTelemetry logger configured internally.
|
Package log gives access to the global OpenTelemetry logger configured internally. |
|
trace
Package trace gives access to the global OpenTelemetry tracer configured internally.
|
Package trace gives access to the global OpenTelemetry tracer configured internally. |
Click to show internal directories.
Click to hide internal directories.