xref: /aosp_15_r20/external/opencensus-java/contrib/http_servlet/README.md (revision a24ffb47c3166327784aa05b149974e82e8f71b8)
1*a24ffb47SSadaf Ebrahimi# OpenCensus Http Servlet Plugin
2*a24ffb47SSadaf Ebrahimi[![Build Status][travis-image]][travis-url]
3*a24ffb47SSadaf Ebrahimi[![Windows Build Status][appveyor-image]][appveyor-url]
4*a24ffb47SSadaf Ebrahimi[![Maven Central][maven-image]][maven-url]
5*a24ffb47SSadaf Ebrahimi
6*a24ffb47SSadaf EbrahimiThe *OpenCensus Http Servlet Plugin for Java* is a plugin for trace instrumentation when using HTTP Servlet 3.0
7*a24ffb47SSadaf Ebrahimi
8*a24ffb47SSadaf Ebrahimi## Quickstart
9*a24ffb47SSadaf Ebrahimi
10*a24ffb47SSadaf Ebrahimi### Add the dependencies to your project
11*a24ffb47SSadaf Ebrahimi
12*a24ffb47SSadaf EbrahimiFor Maven add to your `pom.xml`:
13*a24ffb47SSadaf Ebrahimi```xml
14*a24ffb47SSadaf Ebrahimi<dependencies>
15*a24ffb47SSadaf Ebrahimi  <dependency>
16*a24ffb47SSadaf Ebrahimi    <groupId>io.opencensus</groupId>
17*a24ffb47SSadaf Ebrahimi    <artifactId>opencensus-api</artifactId>
18*a24ffb47SSadaf Ebrahimi    <version>0.28.3</version>
19*a24ffb47SSadaf Ebrahimi  </dependency>
20*a24ffb47SSadaf Ebrahimi  <dependency>
21*a24ffb47SSadaf Ebrahimi    <groupId>io.opencensus</groupId>
22*a24ffb47SSadaf Ebrahimi    <artifactId>opencensus-contrib-http-servlet</artifactId>
23*a24ffb47SSadaf Ebrahimi    <version>0.28.3</version>
24*a24ffb47SSadaf Ebrahimi  </dependency>
25*a24ffb47SSadaf Ebrahimi</dependencies>
26*a24ffb47SSadaf Ebrahimi```
27*a24ffb47SSadaf Ebrahimi
28*a24ffb47SSadaf EbrahimiFor Gradle add to your dependencies:
29*a24ffb47SSadaf Ebrahimi```groovy
30*a24ffb47SSadaf Ebrahimicompile 'io.opencensus:opencensus-api:0.28.3'
31*a24ffb47SSadaf Ebrahimicompile 'io.opencensus:opencensus-contrib-http-servlet:0.28.3'
32*a24ffb47SSadaf Ebrahimi```
33*a24ffb47SSadaf Ebrahimi
34*a24ffb47SSadaf Ebrahimi## Instrumenting HTTP Servlets
35*a24ffb47SSadaf Ebrahimi
36*a24ffb47SSadaf EbrahimiSee [http-server][httpservlet-code] example. Instruction to build and run the example is [here][httpservlet-run].
37*a24ffb47SSadaf Ebrahimi
38*a24ffb47SSadaf Ebrahimi[travis-image]: https://travis-ci.org/census-instrumentation/opencensus-java.svg?branch=master
39*a24ffb47SSadaf Ebrahimi[travis-url]: https://travis-ci.org/census-instrumentation/opencensus-java
40*a24ffb47SSadaf Ebrahimi[appveyor-image]: https://ci.appveyor.com/api/projects/status/hxthmpkxar4jq4be/branch/master?svg=true
41*a24ffb47SSadaf Ebrahimi[appveyor-url]: https://ci.appveyor.com/project/opencensusjavateam/opencensus-java/branch/master
42*a24ffb47SSadaf Ebrahimi[maven-image]: https://maven-badges.herokuapp.com/maven-central/io.opencensus/opencensus-contrib-http-servlet/badge.svg
43*a24ffb47SSadaf Ebrahimi[maven-url]: https://maven-badges.herokuapp.com/maven-central/io.opencensus/opencensus-contrib-http-servlet
44*a24ffb47SSadaf Ebrahimi[httpservlet-run]: https://github.com/census-instrumentation/opencensus-java/tree/master/examples#to-run-http-server-and-client
45*a24ffb47SSadaf Ebrahimi[httpservlet-code]: https://github.com/census-instrumentation/opencensus-java/blob/master/examples/src/main/java/io/opencensus/examples/http/jetty/server/HelloWorldServer.java
46