New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(instrumentation-runtime-node): add prom-client-metrics #2136
Open
pikalovArtemN
wants to merge
13
commits into
open-telemetry:main
Choose a base branch
from
pikalovArtemN:feat/node/prom-client-implementation
base: main
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,400
−114
Open
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
ed6596f
feat(prom-client) add implementation for collecting event loop lag, g…
pikalovArtemN 046072e
test(prom-client) add tests for check implementation
pikalovArtemN d7c5108
chore(prom-client) change version and fix README.md
pikalovArtemN ad88f98
Merge branch 'main' into feat/node/prom-client-implementation
pikalovArtemN 2cd9093
chore(instrumentation-runtime-node): fetch loop lag format in convention
pikalovArtemN 184b212
chore(instrumentation-runtime-node): fetch other metrics to convention
pikalovArtemN 922d677
test(instrumentation-runtime-node):fix some tests
pikalovArtemN 3cba596
chore(instrumentation-runtime-node): sync with conventions
pikalovArtemN 54858de
test(instrumentation-runtime-node): fix tests
pikalovArtemN 926f052
test(instrumentation-runtime-node): fix tests
pikalovArtemN dbb34ff
lint(instrumentation-runtime-node): lint
pikalovArtemN ade0ab9
Merge remote-tracking branch 'origin/feat/node/prom-client-implementa…
pikalovArtemN 7a98bfd
Merge branch 'main' into feat/node/prom-client-implementation
pikalovArtemN File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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
18 changes: 18 additions & 0 deletions
18
plugins/node/instrumentation-runtime-node/src/consts/attributes.ts
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,18 @@ | ||
/* | ||
* 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 | ||
* | ||
* https://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. | ||
*/ | ||
export const NODE_JS_VERSION_ATTRIBUTE = 'nodejsruntime.version'; | ||
export const V8_HEAP_SIZE_STATE_ATTRIBUTE = 'heap.size.state'; | ||
export const V8_HEAP_SIZE = 'heap.size'; |
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
81 changes: 81 additions & 0 deletions
81
plugins/node/instrumentation-runtime-node/src/metrics/baseCollector.ts
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,81 @@ | ||
/* | ||
* 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 | ||
* | ||
* https://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. | ||
*/ | ||
import { MetricCollector } from '../types/metricCollector'; | ||
import { Meter } from '@opentelemetry/api'; | ||
import { clearInterval } from 'node:timers'; | ||
import { RuntimeNodeInstrumentationConfig } from '../types'; | ||
import { NODE_JS_VERSION_ATTRIBUTE } from '../consts/attributes'; | ||
|
||
type VersionAttribute = { [NODE_JS_VERSION_ATTRIBUTE]: string }; | ||
|
||
export abstract class BaseCollector<T> implements MetricCollector { | ||
protected _config: RuntimeNodeInstrumentationConfig = {}; | ||
|
||
protected namePrefix: string; | ||
private _interval: NodeJS.Timeout | undefined; | ||
protected _scrapeQueue: T[] = []; | ||
protected versionAttribute: VersionAttribute; | ||
|
||
protected constructor( | ||
config: RuntimeNodeInstrumentationConfig = {}, | ||
namePrefix: string | ||
) { | ||
this._config = config; | ||
this.namePrefix = namePrefix; | ||
this.versionAttribute = { [NODE_JS_VERSION_ATTRIBUTE]: process.version }; | ||
} | ||
|
||
public disable(): void { | ||
this._clearQueue(); | ||
clearInterval(this._interval); | ||
this._interval = undefined; | ||
|
||
this.internalDisable(); | ||
} | ||
|
||
public enable(): void { | ||
this._clearQueue(); | ||
clearInterval(this._interval); | ||
this._interval = setInterval( | ||
() => this._addTask(), | ||
this._config.monitoringPrecision | ||
); | ||
|
||
// unref so that it does not keep the process running if disable() is never called | ||
this._interval?.unref(); | ||
|
||
this.internalEnable(); | ||
} | ||
|
||
private _clearQueue() { | ||
this._scrapeQueue.length = 0; | ||
} | ||
|
||
private _addTask() { | ||
const taskResult = this.scrape(); | ||
if (taskResult) { | ||
this._scrapeQueue.push(taskResult); | ||
} | ||
} | ||
|
||
public abstract updateMetricInstruments(meter: Meter): void; | ||
|
||
protected abstract internalEnable(): void; | ||
|
||
protected abstract internalDisable(): void; | ||
|
||
protected abstract scrape(): T; | ||
} |
Oops, something went wrong.
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.
type, enjine -> engine