OpenCensus Web exporter for the OpenCensus Agent
For overview and usage info see the main OpenCensus Web readme.
This OpenCensus Web agent exporter allows browser clients to send traces to the
OpenCensus Agent via HTTP/JSON, which the agent
supports via grpc-gateway.
The library is in alpha stage and the API is subject to change.
Overview
This package converts spans from the OpenCensus Web core trace model into the JSON that the OpenCensus Agent expects and sends an XHR to the agent to export the traces. For the shape of the HTTP/JSON API that the OpenCensus Agent expects traces to be sent in, see this auto-generated OpenAPi document for it.
Usage
Currently the primary intended usage of OpenCensus Web is to collect spans from the resource timing waterfall of an initial page load and trace on-page user interactions with a series of features like automatic tracing for clicks and route transitions, custom spans, and browser Performance API data. See the OpenCensus Web readme for details.
In the future we would like to make it easy to generate custom spans that will be conveniently exported to the OpenCensus Agent. This package provides the exporter needed to hook up those custom generated spans to be sent to the agent and ultimately then to a trace storage backend. Although it's not fully wired up and supported yet, you're welcome to poke around the source code and try to use it!
Useful links
- For more information on OpenCensus, visit: https://opencensus.io/
- For more about OpenCensus Web: https://github.com/census-instrumentation/opencensus-web
- For help or feedback on this project, join us on gitter
License
Apache 2.0 - See LICENSE for more information.