-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(all): add common flags for telemetry
- Loading branch information
Showing
11 changed files
with
226 additions
and
172 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| package flags | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/urfave/cli/v2" | ||
| "go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc" | ||
| metricsdk "go.opentelemetry.io/otel/sdk/metric" | ||
| "go.opentelemetry.io/otel/sdk/resource" | ||
| semconv "go.opentelemetry.io/otel/semconv/v1.20.0" | ||
|
|
||
| "github.com/kakao/varlog/pkg/util/telemetry" | ||
| ) | ||
|
|
||
| const ( | ||
| CategoryTelemetry = "Telemetry:" | ||
|
|
||
| TelemetryExporterNOOP = "noop" | ||
| TelemetryExporterStdout = "stdout" | ||
| TelemetryExporterOTLP = "otlp" | ||
|
|
||
| DefaultTelemetryOTLPEndpoint = "localhost:4317" | ||
|
|
||
| DefaultTelemetryStopTimeout = 3 * time.Second | ||
| ) | ||
|
|
||
| var ( | ||
| TelemetryExporter = &cli.StringFlag{ | ||
| Name: "telemetry-exporter", | ||
| Category: CategoryTelemetry, | ||
| Aliases: []string{"exporter-type"}, | ||
| Usage: fmt.Sprintf("Exporter type: %s, %s or %s.", TelemetryExporterNOOP, TelemetryExporterStdout, TelemetryExporterOTLP), | ||
| EnvVars: []string{"TELEMETRY_EXPORTER", "EXPORTER_TYPE"}, | ||
| Value: TelemetryExporterNOOP, | ||
| Action: func(_ *cli.Context, value string) error { | ||
| switch strings.ToLower(value) { | ||
| case TelemetryExporterNOOP, TelemetryExporterStdout, TelemetryExporterOTLP: | ||
| return nil | ||
| default: | ||
| return fmt.Errorf("invalid value \"%s\" for flag --telemetry-exporter", value) | ||
| } | ||
| }, | ||
| } | ||
| TelemetryOTLPEndpoint = &cli.StringFlag{ | ||
| Name: "telemetry-otlp-endpoint", | ||
| Category: CategoryTelemetry, | ||
| Aliases: []string{"exporter-otlp-endpoint"}, | ||
| Usage: "Endpoint for OTLP exporter.", | ||
| EnvVars: []string{"TELEMETRY_OTLP_ENDPOINT", "EXPORTER_OTLP_ENDPOINT"}, | ||
| Value: DefaultTelemetryOTLPEndpoint, | ||
| Action: func(c *cli.Context, value string) error { | ||
| if c.String(TelemetryExporter.Name) != TelemetryExporterOTLP || value != "" { | ||
| return nil | ||
| } | ||
| return errors.New("no value for flag --telemetry-otlp-endpoint") | ||
| }, | ||
| } | ||
| TelemetryOTLPInsecure = &cli.BoolFlag{ | ||
| Name: "telemetry-otlp-insecure", | ||
| Category: CategoryTelemetry, | ||
| Aliases: []string{"exporter-otlp-insecure"}, | ||
| Usage: "Disable gRPC client transport security for OTLP exporter.", | ||
| EnvVars: []string{"TELEMETRY_OTLP_INSECURE", "EXPORTER_OTLP_INSECURE"}, | ||
| } | ||
| TelemetryExporterStopTimeout = &cli.DurationFlag{ | ||
| Name: "telemetry-exporter-stop-timeout", | ||
| Category: CategoryTelemetry, | ||
| Aliases: []string{"expoter-stop-timeout"}, | ||
| Usage: "Timeout for stopping OTLP exporter.", | ||
| EnvVars: []string{"TELEMETRY_EXPORTER_STOP_TIMEOUT", "EXPORTER_STOP_TIMEOUT"}, | ||
| Value: DefaultTelemetryStopTimeout, | ||
| } | ||
| TelemetryHost = &cli.BoolFlag{ | ||
| Name: "telemetry-host", | ||
| Category: CategoryTelemetry, | ||
| Usage: "Export host metrics.", | ||
| EnvVars: []string{"TELEMETRY_HOST"}, | ||
| } | ||
| TelemetryRuntime = &cli.BoolFlag{ | ||
| Name: "telemetry-runtime", | ||
| Category: CategoryTelemetry, | ||
| Usage: "Export runtime metrics.", | ||
| EnvVars: []string{"TELEMETRY_RUNTIME"}, | ||
| } | ||
| ) | ||
|
|
||
| func ParseTelemetryFlags(ctx context.Context, c *cli.Context, serviceName, serviceInstanceID string) (opts []telemetry.MeterProviderOption, err error) { | ||
| const serviceNamespace = "varlog" | ||
|
|
||
| res, err := resource.New(ctx, | ||
| resource.WithFromEnv(), | ||
| resource.WithHost(), | ||
| resource.WithAttributes( | ||
| semconv.ServiceName(serviceName), | ||
| semconv.ServiceNamespace(serviceNamespace), | ||
| semconv.ServiceInstanceID(serviceInstanceID), | ||
| )) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| opts = append(opts, telemetry.WithResource(res)) | ||
|
|
||
| var exporter metricsdk.Exporter | ||
|
|
||
| switch strings.ToLower(c.String(TelemetryExporter.Name)) { | ||
| case TelemetryExporterStdout: | ||
| exporter, err = telemetry.NewStdoutExporter() | ||
| case TelemetryExporterOTLP: | ||
| var opts []otlpmetricgrpc.Option | ||
| if c.Bool(TelemetryOTLPInsecure.Name) { | ||
| opts = append(opts, otlpmetricgrpc.WithInsecure()) | ||
| } | ||
| opts = append(opts, otlpmetricgrpc.WithEndpoint(c.String(TelemetryOTLPEndpoint.Name))) | ||
| exporter, err = telemetry.NewOLTPExporter(context.Background(), opts...) | ||
| case TelemetryExporterNOOP: | ||
| exporter = nil | ||
| } | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| opts = append(opts, telemetry.WithExporter(exporter)) | ||
|
|
||
| if c.Bool(TelemetryHost.Name) { | ||
| opts = append(opts, telemetry.WithHostInstrumentation()) | ||
| } | ||
| if c.Bool(TelemetryRuntime.Name) { | ||
| opts = append(opts, telemetry.WithRuntimeInstrumentation()) | ||
| } | ||
|
|
||
| return opts, nil | ||
| } |
Oops, something went wrong.