[FEATURE] Add support for OpenTelemetry #19
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,72 @@ | ||
| import http from 'k6/http'; | ||
| import { check, sleep } from 'k6'; | ||
| import { randomString } from 'https://jslib.k6.io/k6-utils/1.2.0/index.js'; | ||
|
|
||
| export const options = { | ||
| stages: [ | ||
| { duration: '30s', target: 5 }, // Ramp up to 5 users | ||
| { duration: '1m', target: 5 }, // Stay at 5 users | ||
| { duration: '20s', target: 10 }, // Ramp up to 10 users | ||
| { duration: '1m', target: 10 }, // Stay at 10 users | ||
| { duration: '20s', target: 0 }, // Scale down to 0 users | ||
| ], | ||
| thresholds: { | ||
| http_req_duration: ['p(95)<2000'], // 95% of requests must complete below 2s | ||
| http_req_failed: ['rate<0.1'], // Less than 10% can fail | ||
| }, | ||
| }; | ||
|
|
||
| const BASE_URL = 'http://localhost:8080/api/v1'; | ||
|
|
||
| // Generates a random UUID v4 | ||
| function uuidv4() { | ||
| return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function(c) { | ||
| const r = Math.random() * 16 | 0; | ||
| const v = c == 'x' ? r : (r & 0x3 | 0x8); | ||
| return v.toString(16); | ||
| }); | ||
| } | ||
|
|
||
| export default function () { | ||
| const userId = uuidv4(); | ||
| const authToken = `Bearer ${randomString(32)}`; | ||
|
|
||
| // Add trace context headers | ||
| const headers = { | ||
| 'Authorization': authToken, | ||
| 'traceparent': `00-${randomString(32)}-${randomString(16)}-01`, | ||
| 'Content-Type': 'application/json', | ||
| }; | ||
|
|
||
| // Test user endpoint with trace context | ||
| const userResponse = http.get(`${BASE_URL}/users/${userId}`, { | ||
| headers: headers, | ||
| tags: { name: 'GetUserByID' }, | ||
| }); | ||
|
|
||
| // Check response and add custom span attributes via tags | ||
| check(userResponse, { | ||
| 'status is 401 or 422': (r) => r.status === 401 || r.status === 422, | ||
| 'response time OK': (r) => r.timings.duration < 2000, | ||
| }); | ||
|
|
||
| // Add some variation in the test pattern | ||
| if (Math.random() < 0.3) { | ||
| // Simulate slow requests occasionally | ||
| sleep(2); | ||
| } else { | ||
| sleep(1); | ||
| } | ||
|
|
||
| // Test invalid UUID to generate error traces | ||
| if (Math.random() < 0.1) { | ||
| const invalidResponse = http.get(`${BASE_URL}/users/invalid-uuid`, { | ||
| headers: headers, | ||
| tags: { name: 'GetUserByIDInvalid' }, | ||
| }); | ||
|
|
||
| check(invalidResponse, { | ||
| 'invalid uuid returns 400': (r) => r.status === 400, | ||
| }); | ||
| } | ||
| } |
This file contains hidden or 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 hidden or 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,56 @@ | ||
| package configuration | ||
|
|
||
| import ( | ||
| "strings" | ||
|
|
||
| "github.com/spf13/viper" | ||
| ) | ||
|
|
||
| type Telemetry struct { | ||
| Enabled bool | ||
| Environment string | ||
| Endpoint string | ||
| Headers map[string]string | ||
| Insecure bool | ||
| QueueSize int | ||
| MaxExportBatchSize int | ||
| Compression string | ||
| ServiceName string | ||
| ServiceVersion string | ||
| } | ||
|
|
||
| // TelemetryNew creates a new Telemetry configuration from environment | ||
| func TelemetryNew() *Telemetry { | ||
| viper.SetDefault("OTEL_ENABLED", false) | ||
| viper.SetDefault("OTEL_SERVICE_NAME", "go-api-template") | ||
| viper.SetDefault("OTEL_SERVICE_VERSION", "1.0.0") | ||
| viper.SetDefault("OTEL_EXPORTER_OTLP_ENDPOINT", "localhost:4317") | ||
| viper.SetDefault("OTEL_INSECURE", true) | ||
| viper.SetDefault("OTEL_EXPORTER_OTLP_HEADERS", "") | ||
| viper.SetDefault("OTEL_EXPORTER_OTLP_QUEUE_SIZE", 4096) | ||
| viper.SetDefault("OTEL_EXPORTER_OTLP_MAX_EXPORT_BATCH_SIZE", 512) | ||
| viper.SetDefault("OTEL_EXPORTER_OTLP_COMPRESSION", "gzip") | ||
|
|
||
| headers := make(map[string]string) | ||
| if headerStr := viper.GetString("OTEL_EXPORTER_OTLP_HEADERS"); headerStr != "" { | ||
| for _, header := range strings.Split(headerStr, ",") { | ||
| parts := strings.SplitN(header, "=", 2) | ||
| if len(parts) == 2 { | ||
| headers[parts[0]] = parts[1] | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return &Telemetry{ | ||
| Enabled: viper.GetBool("OTEL_ENABLED"), | ||
| ServiceName: viper.GetString("OTEL_SERVICE_NAME"), | ||
| ServiceVersion: viper.GetString("OTEL_SERVICE_VERSION"), | ||
| Environment: viper.GetString("APP_ENV"), | ||
| Endpoint: viper.GetString("OTEL_EXPORTER_OTLP_ENDPOINT"), | ||
| Headers: headers, | ||
| Insecure: viper.GetBool("OTEL_INSECURE"), | ||
| QueueSize: viper.GetInt("OTEL_EXPORTER_OTLP_QUEUE_SIZE"), | ||
| MaxExportBatchSize: viper.GetInt("OTEL_EXPORTER_OTLP_MAX_EXPORT_BATCH_SIZE"), | ||
| Compression: viper.GetString("OTEL_EXPORTER_OTLP_COMPRESSION"), | ||
| } | ||
| } | ||
This file contains hidden or 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 hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lets call it
NewTelemetry()orNewOpenTelemetry()even