Add metrics framework for frontend and backend #1306
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import React from 'react'; | ||
| import { HttpStart } from '../../../../../src/core/public'; | ||
| import { OBSERVABILITY_BASE } from '../../../common/constants/shared'; | ||
|
|
||
| interface MetricsListenerProps { | ||
| http: HttpStart; | ||
| } | ||
|
|
||
| export const MetricsListener: React.FC<MetricsListenerProps> = (props) => { | ||
| const incrementCountMetric = (element?: string | null) => { | ||
| if (!element) return; | ||
| props.http.post(`${OBSERVABILITY_BASE}/stats`, { | ||
| body: JSON.stringify({ element }), | ||
| }); | ||
| }; | ||
|
|
||
| const onClick: React.MouseEventHandler<HTMLDivElement> = (e) => { | ||
| incrementCountMetric( | ||
| (e.target as HTMLElement | null) | ||
| ?.closest('[data-click-metric-element]') | ||
| ?.getAttribute('data-click-metric-element') | ||
|
Comment on lines
+25
to
+26
There was a problem hiding this comment.
There was a problem hiding this comment. Are we going to be sending these stats anywhere else other than the local index? Any place where we can get the aggregated stats? There was a problem hiding this comment. @derek-ho See description. This PR only adds the framework and some basic examples.
Instrumenting metrics in each element's onClick is tedious comparing to adding an attribute.
Please see description for the "To get metrics" part. |
||
| ); | ||
| }; | ||
|
|
||
| return <div onClick={onClick}>{props.children}</div>; | ||
| }; | ||
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
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,49 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import { ComponentType, CounterType } from './types'; | ||
|
|
||
| export const WINDOW = 3600; | ||
| export const INTERVAL = 60; | ||
| export const CAPACITY = (WINDOW / INTERVAL) * 2; | ||
| export const MILLIS_MULTIPLIER = 1000; | ||
|
|
||
| export const COMPONENTS = [ | ||
| 'application_analytics', | ||
| 'operational_panels', | ||
| 'event_analytics', | ||
| 'notebooks', | ||
| 'trace_analytics', | ||
| 'metrics_analytics', | ||
| ] as const; | ||
| export const REQUESTS = ['create', 'get', 'update', 'delete'] as const; | ||
|
|
||
| export const GLOBAL_BASIC_COUNTER: CounterType = (() => { | ||
| const counter = {} as CounterType; | ||
| COMPONENTS.forEach((component) => { | ||
| counter[component] = {} as CounterType[ComponentType]; | ||
| REQUESTS.forEach((request) => { | ||
| counter[component][request] = { | ||
| total: 0, | ||
| }; | ||
| }); | ||
| }); | ||
| return counter; | ||
| })(); | ||
|
|
||
| export const DEFAULT_ROLLING_COUNTER: CounterType = (() => { | ||
| const counter = {} as CounterType; | ||
| COMPONENTS.forEach((component) => { | ||
| counter[component] = {} as CounterType[ComponentType]; | ||
| REQUESTS.forEach((request) => { | ||
| counter[component][request] = { | ||
| count: 0, | ||
| system_error: 0, | ||
| user_error: 0, | ||
| }; | ||
| }); | ||
| }); | ||
| return counter; | ||
| })(); |
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.
Was 'common/query_manager' instead of './common/query_manager' working for you? I've seen build errors not sure if it's only on my side or not.
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.
this is from tsserver's
_typescript.organizeImportscommand reordering lines, it shouldn't make any difference functionally