Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[exporter/coralogix] Create dynamic subsystem name #7957

Merged
merged 9 commits into from
Mar 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
- `influxdbexporter`: Add support for cumulative, non-monotonic metrics. (#8348)
- `oauth2clientauthextension`: Add support for EndpointParams (#7307)
- Add `NewMetricData` function to `MetricsBuilder` to consistently set instrumentation library name (#8255)
- `coralogixexporter` Allow exporter timeout to be configured (#7957)

### 🛑 Breaking changes 🛑

Expand All @@ -32,6 +33,8 @@
- `prometheusremotewriteexporter` Use `service.*` resource attributes instead of `job` and `instance` resource attributes when adding job and instance labels to metrics (#8266)
- `mysqlreceiver`: instrumentation name updated from `otel/mysql` to `otelcol/mysqlreceiver` (#8387)
- `zookeeperreceiver`: instrumentation name updated from `otelcol/zookeeper` to `otelcol/zookeeperreceiver` (#8389)
- `coralogixexporter`: Create dynamic subsystem name (#7957)
- Deprecate configuration changed. Dynamic subsystem name from traces service name property.

### 🧰 Bug fixes 🧰

Expand Down
10 changes: 7 additions & 3 deletions exporter/coralogixexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Coralogix exporter sends traces to [Coralogix](https://coralogix.com/) as
Coralogix logs.

Supported pipeline types: traces
Supported pipeline types: traces, metrics

> Please review the Collector's [security
> documentation](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/security.md),
Expand All @@ -25,13 +25,17 @@ exporters:
# Traces emitted by this OpenTelemetry exporter should be tagged
# in Coralogix with the following application and subsystem names
application_name: "MyBusinessEnvironment"
# Deprecated: [v0.47.0] SubSystem will remove in the next version
subsystem_name: "MyBusinessSystem"

# Timeout is the timeout for every attempt to send data to the backend.
timeout: 30s
```
### Coralogix's Endpoints
| Region | Traces Endpoint | Metrics Endpoint |
|---------|------------------------------------------|-----------------------------------------|
| USA1 | `tracing-ingress.coralogix.us:9443` | `https://metircs-api.coralogix.us` |
| APAC1 | `tracing-ingress.app.coralogix.in:9443` | `https://metircs-api.coralogix.in` |
| USA1 | `tracing-ingress.coralogix.us:9443` | `https://metrics-api.coralogix.us` |
| APAC1 | `tracing-ingress.app.coralogix.in:9443` | `https://metrics-api.coralogix.in` |
| APAC2 | `tracing-ingress.coralogixsg.com:9443` | `https://metrics-api.coralogixsg.com` |
| EUROPE1 | `tracing-ingress.coralogix.com:9443` | `https://metrics-api.coralogix.com` |
| EUROPE2 | `tracing-ingress.eu2.coralogix.com:9443` | `https://metrics-api.eu2.coralogix.com` |
Expand Down
25 changes: 14 additions & 11 deletions exporter/coralogixexporter/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,14 @@ type coralogixClient struct {
logger *zap.Logger
conn *grpc.ClientConn
client cxpb.CollectorServiceClient
metadata cxpb.Metadata
telemetrySettings component.TelemetrySettings
}

// NewCoralogixClient by Coralogix
func newCoralogixClient(cfg *Config, set component.ExporterCreateSettings) *coralogixClient {
c := &coralogixClient{
cfg: *cfg,
logger: set.Logger,
metadata: cxpb.Metadata{
ApplicationName: cfg.AppName,
SubsystemName: cfg.SubSystem,
},
cfg: *cfg,
logger: set.Logger,
telemetrySettings: set.TelemetrySettings,
}
return c
Expand All @@ -70,12 +65,20 @@ func (c *coralogixClient) newPost(ctx context.Context, td pdata.Traces) error {
if err != nil {
return fmt.Errorf("can't translate to jaeger proto: %w", err)
}

ctx = metadata.NewOutgoingContext(ctx, metadata.New(c.cfg.GRPCClientSettings.Headers))
for _, batch := range batches {

_, err := c.client.PostSpans(ctx, &cxpb.PostSpansRequest{Batch: *batch, Metadata: &c.metadata}, grpc.WaitForReady(false))
if err != nil {
return fmt.Errorf("failed to push trace data via Coralogix exporter %w", err)
if batch.GetProcess().GetServiceName() != "" {
_, err := c.client.PostSpans(ctx, &cxpb.PostSpansRequest{
Batch: *batch,
Metadata: &cxpb.Metadata{ApplicationName: c.cfg.AppName, SubsystemName: batch.GetProcess().GetServiceName()},
}, grpc.WaitForReady(c.cfg.WaitForReady))
if err != nil {
return fmt.Errorf("failed to push trace data via Coralogix exporter %w", err)
}
c.logger.Debug("trace was sent successfully")
} else {
return fmt.Errorf("failed to push trace data via Coralogix exporter because batch.process.serviceName is empty")
}
}
return nil
Expand Down
17 changes: 9 additions & 8 deletions exporter/coralogixexporter/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,10 @@ const (

// Config defines by Coralogix.
type Config struct {
config.ExporterSettings `mapstructure:",squash"`
exporterhelper.QueueSettings `mapstructure:"sending_queue"`
exporterhelper.RetrySettings `mapstructure:"retry_on_failure"`
config.ExporterSettings `mapstructure:",squash"`
exporterhelper.QueueSettings `mapstructure:"sending_queue"`
exporterhelper.RetrySettings `mapstructure:"retry_on_failure"`
exporterhelper.TimeoutSettings `mapstructure:",squash"`

// The Coralogix logs ingress endpoint
configgrpc.GRPCClientSettings `mapstructure:",squash"`
Expand All @@ -40,7 +41,11 @@ type Config struct {

// Traces emitted by this OpenTelemetry exporter should be tagged
// in Coralogix with the following application and subsystem names
AppName string `mapstructure:"application_name"`
AppName string `mapstructure:"application_name"`

// Deprecated: [v0.47.0] SubSystem will remove in the next version
jpkrohling marked this conversation as resolved.
Show resolved Hide resolved
// You can remove 'subsystem_name' from your config file or leave it in this version.
// The subsystem will generate automatically according to the "service_name" of the trace batch.
SubSystem string `mapstructure:"subsystem_name"`
jpkrohling marked this conversation as resolved.
Show resolved Hide resolved
}

Expand All @@ -55,16 +60,12 @@ func (c *Config) Validate() error {
if c.AppName == "" {
return fmt.Errorf("`appName` not specified, please fix the configuration file")
}
if c.SubSystem == "" {
return fmt.Errorf("`subSystem` not specified, please fix the configuration file")
}

// check if headers exists
if len(c.GRPCClientSettings.Headers) == 0 {
c.GRPCClientSettings.Headers = map[string]string{}
}
c.GRPCClientSettings.Headers["ACCESS_TOKEN"] = c.PrivateKey
c.GRPCClientSettings.Headers["appName"] = c.AppName
c.GRPCClientSettings.Headers["subsystemName"] = c.SubSystem
return nil
}
6 changes: 4 additions & 2 deletions exporter/coralogixexporter/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ func TestLoadConfig(t *testing.T) {
RetrySettings: exporterhelper.NewDefaultRetrySettings(),
PrivateKey: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
AppName: "APP_NAME",
SubSystem: "SUBSYSTEM_NAME",
// Deprecated: [v0.47.0] SubSystem will remove in the next version
SubSystem: "SUBSYSTEM_NAME",
TimeoutSettings: exporterhelper.NewDefaultTimeoutSettings(),
GRPCClientSettings: configgrpc.GRPCClientSettings{
Endpoint: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
Compression: "",
Expand All @@ -59,7 +61,7 @@ func TestLoadConfig(t *testing.T) {
ReadBufferSize: 0,
WriteBufferSize: 0,
WaitForReady: false,
Headers: map[string]string{"ACCESS_TOKEN": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "appName": "APP_NAME", "subsystemName": "SUBSYSTEM_NAME"},
Headers: map[string]string{"ACCESS_TOKEN": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "appName": "APP_NAME"},
BalancerName: "",
},
})
Expand Down
2 changes: 2 additions & 0 deletions exporter/coralogixexporter/example/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ exporters:
endpoint: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
private_key: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
application_name: "APP_NAME"
# Deprecated: [v0.47.0] SubSystem will remove in the next version
subsystem_name: "SUBSYSTEM_NAME"
timeout: 5s


service:
Expand Down
3 changes: 2 additions & 1 deletion exporter/coralogixexporter/factory.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ func createDefaultConfig() config.Exporter {
ExporterSettings: config.NewExporterSettings(config.NewComponentID(typestr)),
QueueSettings: exporterhelper.NewDefaultQueueSettings(),
RetrySettings: exporterhelper.NewDefaultRetrySettings(),
TimeoutSettings: exporterhelper.NewDefaultTimeoutSettings(),
GRPCClientSettings: configgrpc.GRPCClientSettings{Endpoint: "https://"},
PrivateKey: "",
AppName: "",
SubSystem: "",
}
}

Expand All @@ -54,6 +54,7 @@ func createTraceExporter(_ context.Context, set component.ExporterCreateSettings
exporter.tracesPusher,
exporterhelper.WithQueue(cfg.QueueSettings),
exporterhelper.WithRetry(cfg.RetrySettings),
exporterhelper.WithTimeout(cfg.TimeoutSettings),
exporterhelper.WithStart(exporter.client.startConnection),
)
}