forked from open-telemetry/opentelemetry-js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(instrumentation-document-load): performance paint timing events (o…
…pen-telemetry#484) * feat(instrumentation-document-load): performance paint timing events * chore: fixed lint
- Loading branch information
1 parent
2a30f62
commit 4a0dab7
Showing
4 changed files
with
143 additions
and
43 deletions.
There are no files selected for viewing
20 changes: 20 additions & 0 deletions
20
plugins/web/opentelemetry-instrumentation-document-load/src/enums/EventNames.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,20 @@ | ||
| /* | ||
| * 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 enum EventNames { | ||
| FIRST_PAINT = 'firstPaint', | ||
| FIRST_CONTENTFUL_PAINT = 'firstContentfulPaint', | ||
| } |
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
79 changes: 79 additions & 0 deletions
79
plugins/web/opentelemetry-instrumentation-document-load/src/utils.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,79 @@ | ||
| /* | ||
| * 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 { Span } from '@opentelemetry/api'; | ||
| import { otperformance } from '@opentelemetry/core'; | ||
| import { | ||
| hasKey, | ||
| PerformanceEntries, | ||
| PerformanceLegacy, | ||
| PerformanceTimingNames as PTN, | ||
| } from '@opentelemetry/web'; | ||
| import { EventNames } from './enums/EventNames'; | ||
|
|
||
| export const getPerformanceNavigationEntries = (): PerformanceEntries => { | ||
| const entries: PerformanceEntries = {}; | ||
| const performanceNavigationTiming = ( | ||
| otperformance as unknown as Performance | ||
| ).getEntriesByType?.('navigation')[0] as PerformanceEntries; | ||
|
|
||
| if (performanceNavigationTiming) { | ||
| const keys = Object.values(PTN); | ||
| keys.forEach((key: string) => { | ||
| if (hasKey(performanceNavigationTiming, key)) { | ||
| const value = performanceNavigationTiming[key]; | ||
| if (typeof value === 'number') { | ||
| entries[key] = value; | ||
| } | ||
| } | ||
| }); | ||
| } else { | ||
| // // fallback to previous version | ||
| const perf: typeof otperformance & PerformanceLegacy = otperformance; | ||
| const performanceTiming = perf.timing; | ||
| if (performanceTiming) { | ||
| const keys = Object.values(PTN); | ||
| keys.forEach((key: string) => { | ||
| if (hasKey(performanceTiming, key)) { | ||
| const value = performanceTiming[key]; | ||
| if (typeof value === 'number') { | ||
| entries[key] = value; | ||
| } | ||
| } | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| return entries; | ||
| }; | ||
|
|
||
| const performancePaintNames = { | ||
| 'first-paint': EventNames.FIRST_PAINT, | ||
| 'first-contentful-paint': EventNames.FIRST_CONTENTFUL_PAINT, | ||
| }; | ||
|
|
||
| export const addSpanPerformancePaintEvents = (span: Span) => { | ||
| const performancePaintTiming = ( | ||
| otperformance as unknown as Performance | ||
| ).getEntriesByType?.('paint'); | ||
| if (performancePaintTiming) { | ||
| performancePaintTiming.forEach(({ name, startTime }) => { | ||
| if (hasKey(performancePaintNames, name)) { | ||
| span.addEvent(performancePaintNames[name], startTime); | ||
| } | ||
| }); | ||
| } | ||
| }; |
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