README
¶
Library for publishing metrics which can be pulled or viewed via HTTP
This is a library which can be used by applications to publish metrics. The metrics are made available via HTTP, using the same port as the webserver for the application. There is a browsable, human-friendly interface as well as machine-friendly interfaces.
Please see the design document and the [public Go API documentation] (https://godoc.org/github.com/Cloud-Foundations/tricorder/go/tricorder) for more information.
Contributions
All contributions must be unencumbered. It is the responsibility of the contributor to ensure compliance with all laws, copyrights, patents and contracts.
LICENSE
Copyright 2015 Symantec Corporation. Copyright 2019 cloud-foundations.org
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.
Directories
¶
| Path | Synopsis |
|---|---|
|
go
|
|
|
healthserver
Package healthserver registers HTTP handlers for health and readiness checks Package healthserver registers HTTP handlers for the /healthz and /readiness paths.
|
Package healthserver registers HTTP handlers for health and readiness checks Package healthserver registers HTTP handlers for the /healthz and /readiness paths. |
|
tricorder
Package tricorder provides health metrics of an application via http.
|
Package tricorder provides health metrics of an application via http. |
|
tricorder/duration
Package duration provides utilities for dealing with times and durations.
|
Package duration provides utilities for dealing with times and durations. |
|
tricorder/messages
Package messages provides the types needed to collect metrics via the go rpc calls and the REST API mentioned in the tricorder package.
|
Package messages provides the types needed to collect metrics via the go rpc calls and the REST API mentioned in the tricorder package. |
|
tricorder/types
Package types contains the various types for metric values.
|
Package types contains the various types for metric values. |
|
tricorder/units
Package units contains the various units of measurement for a metric.
|
Package units contains the various units of measurement for a metric. |