README
¶
OpenCensus Receiver
| Status | |
|---|---|
| Stability | beta: metrics, traces |
| Distributions | core, contrib |
| Issues |   |
| Code Owners | @open-telemetry/collector-approvers |
Receives data via gRPC or HTTP using OpenCensus format.
Getting Started
All that is required to enable the OpenCensus receiver is to include it in the receiver definitions.
receivers:
opencensus:
The following settings are configurable:
endpoint(default = 0.0.0.0:55678): host:port to which the receiver is going to receive data. The valid syntax is described at https://github.com/grpc/grpc/blob/master/doc/naming.md. Thecomponent.UseLocalHostAsDefaultHostfeature gate changes this to localhost:55678. This will become the default in a future release.
Advanced Configuration
Several helper files are leveraged to provide additional capabilities automatically:
Writing with HTTP/JSON
The OpenCensus receiver can receive trace export calls via HTTP/JSON in addition to gRPC. The HTTP/JSON address is the same as gRPC as the protocol is recognized and processed accordingly.
To write traces with HTTP/JSON, POST to [address]/v1/trace. The JSON message
format parallels the gRPC protobuf format, see this
OpenApi spec for it.
The HTTP/JSON endpoint can also optionally configure
CORS, which is enabled by
specifying a list of allowed CORS origins in the cors_allowed_origins field:
receivers:
opencensus:
cors_allowed_origins:
- http://test.com
# Origins can have wildcards with *, use * by itself to match any origin.
- https://*.example.com
Documentation
¶
Overview ¶
Package opencensusreceiver receives OpenCensus traces and metrics.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewFactory ¶
NewFactory creates a new OpenCensus receiver factory.
Types ¶
type Config ¶
type Config struct {
// Configures the receiver server protocol.
configgrpc.ServerConfig `mapstructure:",squash"` // squash ensures fields are correctly decoded in embedded struct
// CorsOrigins are the allowed CORS origins for HTTP/JSON requests to grpc-gateway adapter
// for the OpenCensus receiver. See github.com/rs/cors
// An empty list means that CORS is not enabled at all. A wildcard (*) can be
// used to match any origin or one or more characters of an origin.
CorsOrigins []string `mapstructure:"cors_allowed_origins"`
}
Config defines configuration for OpenCensus receiver.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
ocmetrics
Package ocmetrics is the logic for receiving OpenCensus metrics proto from already instrumented applications and then passing them onto a metricsink instance.
|
Package ocmetrics is the logic for receiving OpenCensus metrics proto from already instrumented applications and then passing them onto a metricsink instance. |
|
octrace
Package octrace is the logic for receiving OpenCensus trace protobuf defined spans from already instrumented applications and then passing them onto a TracesReceiverSink instance.
|
Package octrace is the logic for receiving OpenCensus trace protobuf defined spans from already instrumented applications and then passing them onto a TracesReceiverSink instance. |