Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/census-ecosystem/opencensus-scala
A scala wrapper for the opencensus-java library
https://github.com/census-ecosystem/opencensus-scala
Last synced: 3 months ago
JSON representation
A scala wrapper for the opencensus-java library
- Host: GitHub
- URL: https://github.com/census-ecosystem/opencensus-scala
- Owner: census-ecosystem
- License: apache-2.0
- Archived: true
- Created: 2018-03-17T11:26:08.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-01-29T16:32:07.000Z (over 3 years ago)
- Last Synced: 2023-03-01T00:01:44.323Z (over 1 year ago)
- Language: Scala
- Size: 1.41 MB
- Stars: 51
- Watchers: 8
- Forks: 19
- Open Issues: 57
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-opencensus - opencensus-scala - java (Integrations / Java)
README
[](https://travis-ci.org/census-ecosystem/opencensus-scala)
# opencensus-scala
This project is a lightweight scala wrapper for the
[opencensus-java](https://github.com/census-instrumentation/opencensus-java) library
and provides instrumentation for scala based frameworks.
The API documentation can be found [here](https://census-ecosystem.github.io/opencensus-scala/api/).
## Implementation status
Opencensus-scala supports the tracing and stats apis of opencensus.
### Instrumentations
|Framework|Tracing |Stats |
|---------|-----------|---------|
|Akka HTTP|supported |planned |
|Http4s |supported |planned |
|Elastic4s|supported |planned |
|Play |planned |planned |
## Quickstart
### Dependencies
Add the following dependencies to your sbt project.
```scala
// If you want to use only the core module
"com.github.sebruck" %% "opencensus-scala-core" % "0.7.2"
// Dependent on the trace exporters you want to use add one or more of the following
"io.opencensus" % "opencensus-exporter-trace-stackdriver" % "0.25.0"
"io.opencensus" % "opencensus-exporter-trace-logging" % "0.25.0"
"io.opencensus" % "opencensus-exporter-trace-instana" % "0.25.0"
"io.opencensus" % "opencensus-exporter-trace-zipkin" % "0.25.0"
// If you want to use opencensus-scala inside an Akka HTTP project
"com.github.sebruck" %% "opencensus-scala-akka-http" % "0.7.2"
// If you want to use opencensus-scala inside a http4s project
"com.github.sebruck" %% "opencensus-scala-http4s" % "0.7.2"
// If you want to use opencensus-scala inside a elastic4s project
"com.github.sebruck" %% "opencensus-scala-elastic4s" % "0.7.2"
```
### Configuration
opencensus-scala uses [typesafe config](https://github.com/lightbend/config) to configure exporters,
sampling rates and many more. For a full reference have a look at
[the default configuration](core/src/main/resources/reference.conf).
To activate the Stackdriver trace exporter with the default sampling rate of 1/10000 add the following
to your application.conf.
```
opencensus-scala {
trace {
exporters {
stackdriver {
enabled = true
project-id = "MY-GC-Project"
}
}
}
}
```
For documentation how to use the several modules, have a look at the [modules](#modules) section.
## Modules
### Core
Utilities to use opencensus in a scala idiomatic way.
Learn more at the [documentation](core/README.md).
### Akka HTTP
Utilities to use opencensus in [Akka HTTP](https://github.com/akka/akka-http) applications.
Learn more at the [documentation](akka-http/README.md).
### http4s
Utilities to use opencensus in [http4s](https://github.com/http4s/http4s) applications.
Learn more at the [documentation](http4s/README.md).
### doobie
Utilities to use opencensus in [doobie](https://github.com/tpolecat/doobie) applications.
Learn more at the [documentation](doobie/README.md).
### elastic4s
Utilities to use opencensus in [elastic4s](https://github.com/sksamuel/elastic4s) applications.
Learn more at the [documentation](elastic4s/README.md).
## Contributing
Contributions are very welcome! As a starting point, have a look at the open issues.
Please also check the [CONTRIBUTION.md](CONTRIBUTION.md).