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/Symantec/tricorder/go/tricorder) for more information.
Contributions
Prior to receiving information from any contributor, Symantec requires that all contributors complete, sign, and submit Symantec Personal Contributor Agreement (SPCA). The purpose of the SPCA is to clearly define the terms under which intellectual property has been contributed to the project and thereby allow Symantec to defend the project should there be a legal dispute regarding the software at some future time. A signed SPCA is required to be on file before an individual is given commit privileges to the Symantec open source project. Please note that the privilege to commit to the project is conditional and may be revoked by Symantec.
If you are employed by a corporation, a Symantec Corporate Contributor Agreement (SCCA) is also required before you may contribute to the project. If you are employed by a company, you may have signed an employment agreement that assigns intellectual property ownership in certain of your ideas or code to your company. We require a SCCA to make sure that the intellectual property in your contribution is clearly contributed to the Symantec open source project, even if that intellectual property had previously been assigned by you.
Please complete the SPCA and, if required, the SCCA and return to Symantec at:
Symantec Corporation Legal Department Attention: Product Legal Support Team 350 Ellis Street Mountain View, CA 94043
Please be sure to keep a signed copy for your records.
LICENSE
Copyright 2015 Symantec Corporation.
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. |