Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add env support for batch span processor (#2515)
* Add env support for batch span processor * Update changelog * lint
- Loading branch information
Showing
5 changed files
with
220 additions
and
6 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package trace // import "go.opentelemetry.io/otel/sdk/trace" | ||
|
|
||
| import ( | ||
| "os" | ||
| "strconv" | ||
|
|
||
| "go.opentelemetry.io/otel/internal/global" | ||
| ) | ||
|
|
||
| // Environment variable names | ||
| const ( | ||
| // EnvBatchSpanProcessorScheduleDelay | ||
| // Delay interval between two consecutive exports. | ||
| // i.e. 5000 | ||
| EnvBatchSpanProcessorScheduleDelay = "OTEL_BSP_SCHEDULE_DELAY" | ||
| // EnvBatchSpanProcessorExportTimeout | ||
| // Maximum allowed time to export data. | ||
| // i.e. 3000 | ||
| EnvBatchSpanProcessorExportTimeout = "OTEL_BSP_EXPORT_TIMEOUT" | ||
| // EnvBatchSpanProcessorMaxQueueSize | ||
| // Maximum queue size | ||
| // i.e. 2048 | ||
| EnvBatchSpanProcessorMaxQueueSize = "OTEL_BSP_MAX_QUEUE_SIZE" | ||
| // EnvBatchSpanProcessorMaxExportBatchSize | ||
| // Maximum batch size | ||
| // Note: Must be less than or equal to EnvBatchSpanProcessorMaxQueueSize | ||
| // i.e. 512 | ||
| EnvBatchSpanProcessorMaxExportBatchSize = "OTEL_BSP_MAX_EXPORT_BATCH_SIZE" | ||
| ) | ||
|
|
||
| // intEnvOr returns an env variable's numeric value if it is exists (and valid) or the default if not | ||
| func intEnvOr(key string, defaultValue int) int { | ||
| value, ok := os.LookupEnv(key) | ||
| if !ok { | ||
| return defaultValue | ||
| } | ||
|
|
||
| intValue, err := strconv.Atoi(value) | ||
| if err != nil { | ||
| global.Info("Got invalid value, number value expected.", key, value) | ||
| return defaultValue | ||
| } | ||
|
|
||
| return intValue | ||
| } |
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,60 @@ | ||
| // Copyright The OpenTelemetry Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package trace | ||
|
|
||
| import ( | ||
| "os" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
|
|
||
| ottest "go.opentelemetry.io/otel/internal/internaltest" | ||
| ) | ||
|
|
||
| func TestIntEnvOr(t *testing.T) { | ||
| testCases := []struct { | ||
| name string | ||
| envValue string | ||
| defaultValue int | ||
| expectedValue int | ||
| }{ | ||
| { | ||
| name: "IntEnvOrTest - Basic", | ||
| envValue: "2500", | ||
| defaultValue: 500, | ||
| expectedValue: 2500, | ||
| }, | ||
| { | ||
| name: "IntEnvOrTest - Invalid Number", | ||
| envValue: "localhost", | ||
| defaultValue: 500, | ||
| expectedValue: 500, | ||
| }, | ||
| } | ||
|
|
||
| envStore := ottest.NewEnvStore() | ||
| envStore.Record(EnvBatchSpanProcessorMaxQueueSize) | ||
| defer func() { | ||
| require.NoError(t, envStore.Restore()) | ||
| }() | ||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| require.NoError(t, os.Setenv(EnvBatchSpanProcessorMaxQueueSize, tc.envValue)) | ||
| actualValue := intEnvOr(EnvBatchSpanProcessorMaxQueueSize, tc.defaultValue) | ||
| assert.Equal(t, tc.expectedValue, actualValue) | ||
| }) | ||
| } | ||
| } |