# README
go-kit/metrics - Metrics Module
- About this module
- Installation
- Usage
- Code of Conduct
- Working Language
- Support and Feedback
- How to Contribute
- Licensing
The metrics module provides a set of tools to collect and expose metrics for a Go application.
About this module
This module provides two wrappers around OpenTelemetry and Prometheus to initialize a trace provider and a prometheus registry.
Installation
To install, run:
go get github.com/lvlcn-t/go-kit/metrics
And import the package in your code:
import "github.com/lvlcn-t/go-kit/metrics"
Usage
The documentation for this module can be found on pkg.go.dev.
To see how to use this module, you can check the examples directory of the repository.
Code of Conduct
This project has adopted the Contributor Covenant in version 2.1 as our code of conduct. Please see the details in our CODE_OF_CONDUCT.md. All contributors must abide by the code of conduct.
Working Language
We decided to apply English as the primary project language.
Consequently, all content will be made available primarily in English. We also ask all interested people to use English as the preferred language to create issues, in their code (comments, documentation, etc.) and when you send requests to us. The application itself and all end-user facing content will be made available in other languages as needed.
Support and Feedback
The following channels are available for discussions, feedback, and support requests:
| Type | Channel |
|---|---|
| Issues |  |
How to Contribute
Contribution and feedback is encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines. By participating in this project, you agree to abide by its Code of Conduct at all times.
Licensing
Copyright (c) 2024 lvlcn-t.
Licensed under the MIT (the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License at https://www.mit.edu/~amini/LICENSE.md.
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.