Skip to content

Commit 66ee4d6

Browse files
authored
refactor(configuration): improvements on package (#6101)
1 parent ded89b5 commit 66ee4d6

28 files changed

+109
-159
lines changed

experimental/CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
1111
### :rocket: Features
1212

1313
* feat(exporter-prometheus): support withoutScopeInfo option [#5993](https://github.com/open-telemetry/opentelemetry-js/pull/5993) @cjihrig
14+
* feat(configuration): improvements on package [#6101](https://github.com/open-telemetry/opentelemetry-js/pull/6101) @maryliag
1415

1516
### :bug: Bug Fixes
1617

File renamed without changes.

experimental/packages/opentelemetry-configuration/package.json renamed to experimental/packages/configuration/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,6 @@
5656
"ts-loader": "9.5.4",
5757
"typescript": "5.0.4"
5858
},
59-
"homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-configuration",
59+
"homepage": "https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/configuration",
6060
"sideEffects": false
6161
}

experimental/packages/opentelemetry-configuration/src/ConfigProvider.ts renamed to experimental/packages/configuration/src/ConfigFactory.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@
1414
* limitations under the License.
1515
*/
1616

17-
import { ConfigProvider } from './IConfigProvider';
18-
import { EnvironmentConfigProvider } from './EnvironmentConfigProvider';
19-
import { FileConfigProvider, hasValidConfigFile } from './FileConfigProvider';
17+
import { ConfigFactory } from './IConfigFactory';
18+
import { EnvironmentConfigFactory } from './EnvironmentConfigFactory';
19+
import { FileConfigFactory, hasValidConfigFile } from './FileConfigFactory';
2020

21-
export function createConfigProvider(): ConfigProvider {
21+
export function createConfigFactory(): ConfigFactory {
2222
if (hasValidConfigFile()) {
23-
return new FileConfigProvider();
23+
return new FileConfigFactory();
2424
}
25-
return new EnvironmentConfigProvider();
25+
return new EnvironmentConfigFactory();
2626
}
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import {
2525
diagLogLevelFromString,
2626
getNumberFromEnv,
2727
} from '@opentelemetry/core';
28-
import { ConfigProvider } from './IConfigProvider';
28+
import { ConfigFactory } from './IConfigFactory';
2929
import {
3030
ExemplarFilter,
3131
ExporterDefaultHistogramAggregation,
@@ -35,7 +35,7 @@ import {
3535
/**
3636
* EnvironmentConfigProvider provides a configuration based on environment variables.
3737
*/
38-
export class EnvironmentConfigProvider implements ConfigProvider {
38+
export class EnvironmentConfigFactory implements ConfigFactory {
3939
private _config: ConfigurationModel;
4040

4141
constructor() {
@@ -62,7 +62,7 @@ export class EnvironmentConfigProvider implements ConfigProvider {
6262
setLoggerProvider(this._config);
6363
}
6464

65-
getInstrumentationConfig(): ConfigurationModel {
65+
getConfigModel(): ConfigurationModel {
6666
return this._config;
6767
}
6868
}
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import {
2121
ConfigurationModel,
2222
initializeDefaultConfiguration,
2323
} from './models/configModel';
24-
import { ConfigProvider } from './IConfigProvider';
24+
import { ConfigFactory } from './IConfigFactory';
2525
import * as fs from 'fs';
2626
import * as yaml from 'yaml';
2727
import {
@@ -61,15 +61,15 @@ import {
6161
ViewStream,
6262
} from './models/meterProviderModel';
6363

64-
export class FileConfigProvider implements ConfigProvider {
64+
export class FileConfigFactory implements ConfigFactory {
6565
private _config: ConfigurationModel;
6666

6767
constructor() {
6868
this._config = initializeDefaultConfiguration();
6969
parseConfigFile(this._config);
7070
}
7171

72-
getInstrumentationConfig(): ConfigurationModel {
72+
getConfigModel(): ConfigurationModel {
7373
return this._config;
7474
}
7575
}

experimental/packages/opentelemetry-configuration/src/IConfigProvider.ts renamed to experimental/packages/configuration/src/IConfigFactory.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@
1616

1717
import { ConfigurationModel } from './models/configModel';
1818

19-
export interface ConfigProvider {
19+
export interface ConfigFactory {
2020
/**
21-
* Returns a ConfigurationModel, used for instrumentation configuration
21+
* Returns a ConfigurationModel.
2222
*
2323
* @returns ConfigurationModel a Configuration Model with all configuration attributes
2424
*/
25-
getInstrumentationConfig(): ConfigurationModel;
25+
getConfigModel(): ConfigurationModel;
2626
}

0 commit comments

Comments
 (0)