README
¶
Common library for the NTP Pool project with shared infrastructure components.
Packages
- apitls - TLS setup for NTP Pool internal services with embedded CA
- config - NTP Pool project configuration with environment variables
- ekko - Enhanced Echo web framework with observability middleware
- health - Standalone health check HTTP server
- kafka - Kafka client wrapper with TLS support
- logger - Structured logging with OpenTelemetry integration
- metricsserver - Prometheus metrics HTTP server
- timeutil - JSON-serializable duration types
- tracing - OpenTelemetry distributed tracing setup
- types - Shared data structures for NTP Pool
- ulid - Thread-safe ULID generation
- version - Build metadata and version information
- xff/fastlyxff - Fastly CDN IP range management
Directories
¶
| Path | Synopsis |
|---|---|
|
Package apitls provides TLS certificate management with automatic renewal support.
|
Package apitls provides TLS certificate management with automatic renewal support. |
|
Package config provides environment-based configuration management for NTP Pool services.
|
Package config provides environment-based configuration management for NTP Pool services. |
|
depenv
Package depenv provides deployment environment management for NTP Pool services.
|
Package depenv provides deployment environment management for NTP Pool services. |
|
Package ekko provides an enhanced Echo web framework wrapper with pre-configured middleware.
|
Package ekko provides an enhanced Echo web framework wrapper with pre-configured middleware. |
|
Package health provides a standalone HTTP server for health checks.
|
Package health provides a standalone HTTP server for health checks. |
|
internal
|
|
|
otlpresource
Package otlpresource builds the OpenTelemetry resource shared between the tracing and logger packages so spans, metrics, and logs describe the same process with the same attributes (service.name, process.pid, host.*, etc.).
|
Package otlpresource builds the OpenTelemetry resource shared between the tracing and logger packages so spans, metrics, and logs describe the same process with the same attributes (service.name, process.pid, host.*, etc.). |
|
tracerconfig
Package tracerconfig provides a bridge to eliminate circular dependencies between the logger and tracing packages.
|
Package tracerconfig provides a bridge to eliminate circular dependencies between the logger and tracing packages. |
|
Package kafconn provides a Kafka client wrapper with TLS support for secure log streaming.
|
Package kafconn provides a Kafka client wrapper with TLS support for secure log streaming. |
|
Package logger provides structured logging with OpenTelemetry trace integration.
|
Package logger provides structured logging with OpenTelemetry trace integration. |
|
Package metrics provides OpenTelemetry-native metrics with OTLP export support.
|
Package metrics provides OpenTelemetry-native metrics with OTLP export support. |
|
Package metricsserver provides a standalone HTTP server for exposing Prometheus metrics.
|
Package metricsserver provides a standalone HTTP server for exposing Prometheus metrics. |
|
Package timeutil provides JSON-serializable time utilities.
|
Package timeutil provides JSON-serializable time utilities. |
|
Package tracing provides OpenTelemetry distributed tracing setup with OTLP export support.
|
Package tracing provides OpenTelemetry distributed tracing setup with OTLP export support. |
|
Package types provides shared data structures for the NTP Pool project.
|
Package types provides shared data structures for the NTP Pool project. |
|
Package ulid provides thread-safe ULID (Universally Unique Lexicographically Sortable Identifier) generation.
|
Package ulid provides thread-safe ULID (Universally Unique Lexicographically Sortable Identifier) generation. |
|
Package version provides build metadata and version information management.
|
Package version provides build metadata and version information management. |
|
Package xff provides trusted proxy handling and real client IP extraction from X-Forwarded-For headers.
|
Package xff provides trusted proxy handling and real client IP extraction from X-Forwarded-For headers. |
|
echo
Package xffecho adapts xff.TrustedProxies for use with the Echo web framework's X-Forwarded-For IP extraction.
|
Package xffecho adapts xff.TrustedProxies for use with the Echo web framework's X-Forwarded-For IP extraction. |
|
fastlyxff
Package fastlyxff loads Fastly CDN IP ranges and returns a generic xff.TrustedProxies for trusted proxy handling.
|
Package fastlyxff loads Fastly CDN IP ranges and returns a generic xff.TrustedProxies for trusted proxy handling. |
Click to show internal directories.
Click to hide internal directories.