Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/expediadotcom/haystack-logback-metrics-appender
A logback appender that sends an error count to a graphite endpoint
https://github.com/expediadotcom/haystack-logback-metrics-appender
Last synced: 1 day ago
JSON representation
A logback appender that sends an error count to a graphite endpoint
- Host: GitHub
- URL: https://github.com/expediadotcom/haystack-logback-metrics-appender
- Owner: ExpediaDotCom
- License: apache-2.0
- Created: 2017-11-14T19:01:42.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-28T21:37:54.000Z (almost 6 years ago)
- Last Synced: 2023-07-26T21:48:09.342Z (over 1 year ago)
- Language: Java
- Homepage:
- Size: 73.2 KB
- Stars: 1
- Watchers: 14
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://coveralls.io/github/ExpediaDotCom/haystack-logback-metrics-appender?branch=master)
[](https://travis-ci.org/ExpediaDotCom/haystack-logback-metrics-appender)
# haystack-logback-metrics-appender
A logback appender that sends an error count to a graphite endpoint
## Overview
To facilitate counting errors and alarming when they occur, this package contains a
[Logback](https://logback.qos.ch/)
[Appender](https://logback.qos.ch/apidocs/ch/qos/logback/core/Appender.html)
that sends a [Graphite](https://graphiteapp.org/)
[plaintext protocol](http://graphite.readthedocs.io/en/latest/feeding-carbon.html#the-plaintext-protocol)
message to a Graphite endpoint. The intent of this Appender is to make it easier to alarm on error messages,
using the [Grafana](https://grafana.com/) [alert notifications](http://docs.grafana.org/alerting/notifications/),
or a similar metrics-based mechanism.
### Metric Message Format
Graphite plain text protocol messages are of the form ` ` where `` is typically a
period-delimited String, `` is a number (either integer or floating point) and `` is a Linux epoch
style number (milliseconds since January 1, 1970, midnight GMT). The format of the `` created by
[EmitToGraphiteLogbackAppender](https://github.com/ExpediaDotCom/haystack-logback-metrics-appender/blob/master/src/main/java/com/expedia/www/haystack/metrics/appenders/logback/EmitToGraphiteLogbackAppender.java)
is used in the data.influxdb.templates array [here](https://github.com/ExpediaDotCom/haystack/blob/master/deployment/k8s/addons/1.6/monitoring/influxdb.yaml#L91)
and is of the following format:
```haystack.errors....._```
where
* `` is the name of the subsystem (like `pipes`, `collector`, etc.).
* `` is something like `com-foo-MyClass` (`com.foo` is the package, `MyClass` is the name of
the class, and all the periods in the package have been replaced by hyphens).
* `` is the name of the server where the error occurred.
* `` is the line number in MyClass.java or MyClass.scala where the call to log the error was made.
* `ERROR_TYPE` is either `ERROR` or `FATAL`.
* `` is TODO list the metric suffixes added by Servo.
### Building
Simply run `mvn clean package` from the root directory of the cloned repository.
### Releases
1. Decide what kind of version bump is necessary, based on [Semantic Versioning](http://semver.org/) conventions.
In the items below, the version number you select will be referred to as `x.y.z`.
2. Update the [pom.xml](https://github.com/ExpediaDotCom/haystack-logback-metrics-appender/blob/master/pom.xml),
changing the version element to `x.y.z-SNAPSHOT`. Note the `-SNAPSHOT` suffix.
3. Make your code changes, including unit tests. This package requires 100% unit test code coverage for the build to
succeed.
4. Update the
[ReleaseNotes.md]((https://github.com/ExpediaDotCom/haystack-logback-metrics-appender/blob/master/ReleaseNotes.md))
file with details of your changes.
5. Create a pull request with your changes.
6. Ask for a review of the pull request; when it is approved, the Travis CI build will upload the resulting jar file
to the [SonaType Staging Repository](https://oss.sonatype.org/#stagingRepositories).
7. Tag the build with the version number: from a command line, executed in the root directory of the project:
```
git tag x.y.z
git push --tags
```
This will cause the jar file to be released to the
[SonaType Release Repository](https://oss.sonatype.org/#nexus-search;quick~haystack-logback-metrics-appender).