README
¶
OpenKCM: common-sdk
About this project
Having common set of functionality used by all OpenKCM Services/Applications as logging, opentelemetry metrics, traces and logs, etc. .
Requirements and Setup
Insert a short description what is required to get your project running...
Support, Feedback, Contributing
This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.
Security / Disclosure
If you find any bug that may be a security problem, please follow our instructions at in our security policy on how to report it. Please do not create GitHub issues for security-related doubts or problems.
Code of Conduct
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.
Licensing
Copyright 2025 SAP SE or an SAP affiliate company and OpenKCM contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
pkg
|
|
|
auth
Package auth provides a way to encode, decode, and verify client data using signatures.
|
Package auth provides a way to encode, decode, and verify client data using signatures. |
|
commoncfg
Package commoncfg defines the necessary types to configure the application.
|
Package commoncfg defines the necessary types to configure the application. |
|
commonfs/loader
Package loader provides a file-system based resource loader with live updates.
|
Package loader provides a file-system based resource loader with live updates. |
|
commonfs/notifier
Package notifier provides a grouped event notification mechanism that accumulates filesystem events and errors and triggers user-defined callbacks at controlled intervals.
|
Package notifier provides a grouped event notification mechanism that accumulates filesystem events and errors and triggers user-defined callbacks at controlled intervals. |
|
commonfs/watcher
Package watcher provides a thin wrapper around fsnotify for watching file system paths.
|
Package watcher provides a thin wrapper around fsnotify for watching file system paths. |
|
commongrpc
Package commongrpc provides helpers for creating and managing gRPC clients with support for connection pooling, telemetry instrumentation, keepalive configuration, and secure or insecure transport credentials (including mTLS).
|
Package commongrpc provides helpers for creating and managing gRPC clients with support for connection pooling, telemetry instrumentation, keepalive configuration, and secure or insecure transport credentials (including mTLS). |
|
commonhttp
Package commonhttp provides utilities to create HTTP clients configured with OAuth2 credentials and optional mutual TLS (mTLS).
|
Package commonhttp provides utilities to create HTTP clients configured with OAuth2 credentials and optional mutual TLS (mTLS). |
|
fingerprint
Package fingerprint provides utilities to generate request fingerprints used by the OpenKCM Session Manager and ExtAuthZ components.
|
Package fingerprint provides utilities to generate request fingerprints used by the OpenKCM Session Manager and ExtAuthZ components. |
|
storage/keyvalue
Package keyvalue provides simple in-memory key–value storage utilities with generic type parameters for keys and values.
|
Package keyvalue provides simple in-memory key–value storage utilities with generic type parameters for keys and values. |