add prom metrics api to terafoundation #3594
Merged
Conversation
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
godber
reviewed
Apr 24, 2024
godber
reviewed
Apr 24, 2024
godber
reviewed
Apr 24, 2024
godber
reviewed
Apr 24, 2024
godber
reviewed
Apr 24, 2024
bump: (minor) @terascope/[email protected], [email protected] bump: (minor) @terascope/[email protected], @terascope/[email protected] bump: (minor) @terascope/[email protected], @terascope/[email protected] bump: (minor) [email protected], [email protected] bump: (minor) [email protected], [email protected] bump: (minor) @terascope/[email protected], @terascope/[email protected]
|
Current Prom Metrics output for master: |
godber
approved these changes
May 1, 2024
| @@ -101,9 +105,12 @@ export type FoundationSysConfig<S> = { | |||
| log_path: string; | |||
| log_level: LogLevelConfig; | |||
| logging: LogType[]; | |||
| asset_storage_connection_type?: string; | |||
| asset_storage_connection?: string; | |||
| asset_storage_connection_type: string; | |||
There was a problem hiding this comment.
Why have these gone from being optional in this PR?
Also, it's just occurred to me that asset_storage_connection_type shouldn't be in the terafoundation config, it should be in the teraslice config right? there are no assets in other terafoundation apps (spaces). This isn't really relevant for this PR though.
There was a problem hiding this comment.
I realized that a FoundationSysConfig type is only created after the terafoundation config has run through convict and defaults have been inserted. asset_storage_connection_type and asset_storage_connection should and will always exist on this type. There are most likely a few if (field exists) statements that can be removed since I made this change.
| it('should not initialize a promMetricsAPI', async () => { | ||
| const result = await context.apis.foundation.promMetrics.init(config); | ||
| expect(result).toBe(false); | ||
| }); |
There was a problem hiding this comment.
I would have probably chosen to try a some other api calls here to ensure they don't blow up.
There was a problem hiding this comment.
Although maybe there's other cases where other apis are tested and shown to not throw when it's all disabled.
There was a problem hiding this comment.
I went ahead and added a few.
| @@ -38,7 +38,7 @@ export class AssetsService { | |||
|
|
|||
| async initialize() { | |||
| try { | |||
| this.assetsStorage = await new AssetsStorage(this.context); | |||
| this.assetsStorage = new AssetsStorage(this.context); | |||
There was a problem hiding this comment.
Again, why is there an AssetsStorage related change here?
There was a problem hiding this comment.
I just noticed that the await was unnecessary. Maybe I should have done that in another PR.
|
All of the comments about the asset storage stuff ... is important but unrelated to this PR. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR makes the following changes:
PromMetricsandExporterclasses fromstandard-assetsintoterafoundationpromMetricsas a field tocontext.apis.foundation, allowing the promMetrics class to be used anywhere that usesterafoundation. ApromMetricsProxyis used to catch calls topromMetricsif metrics are disabled.terafoundationschema.tsandjob-componentsjob-schemas.ts. Values in ajobConfigwill override values interafoundation.prom_metrics_enabled- start a Prometheus exporter serverprom_metrics_port- port the server will listen onprom_metrics_add_defaults- collect default metrics recommended by Prometheus as well as Node.js-specific metrics.MockPromMetricsinjob-componentsTestContextto be used in unit tests.terafoundation,typesandjob-components.promMetrics.initand add an info metric toClusterMaster,SlicerExecutionContextandWorkerExecutionContextclasses.ref: #3360