[FEATURE] prometheus & timeserieschart: Add annotation support#642
Draft
Gladorme wants to merge 11 commits into
Draft
[FEATURE] prometheus & timeserieschart: Add annotation support#642Gladorme wants to merge 11 commits into
Gladorme wants to merge 11 commits into
Conversation
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
Signed-off-by: Guillaume LADORME <Gladorme@users.noreply.github.com>
6 tasks
Gladorme
changed the title
6 tasks
shahrokni
reviewed
May 27, 2026
| "@perses-dev/components": "^0.53.1", | ||
| "@perses-dev/core": "^0.53.0", | ||
| "@perses-dev/plugin-system": "^0.53.1", | ||
| "@perses-dev/plugin-system": "file:../../shared/plugin-system", |
Contributor
There was a problem hiding this comment.
"file:../../shared/plugin-system ?
| @@ -0,0 +1,97 @@ | |||
| import { AnnotationData } from '@perses-dev/spec'; | |||
| import { AnnotationContext, datasourceSelectValueToSelector, replaceVariables } from '@perses-dev/plugin-system'; | |||
| import { DatasourceSpec, parseDurationString } from '@perses-dev/core'; | |||
Contributor
There was a problem hiding this comment.
Please avoid using core.
All types have been placed either in spec or in shared packages.
| import { ReactElement } from 'react'; | ||
| import { useId } from '@perses-dev/components'; | ||
| import { produce } from 'immer'; | ||
| import { Autocomplete, Chip, FormControl, Stack, TextField } from '@mui/material'; |
Contributor
There was a problem hiding this comment.
'Chip' is declared but its value is never read.ts(6133)
Comment on lines
+58
to
+64
| const formatDate = (timeMs: number): { date: string; time: string } => { | ||
| const d = new Date(timeMs); | ||
| return { | ||
| date: formatWithUserTimeZone(d, 'MMM dd, yyyy'), | ||
| time: formatWithUserTimeZone(d, 'HH:mm:ss'), | ||
| }; | ||
| }; |
Contributor
There was a problem hiding this comment.
The exact same method was added to the /shared/plugin-system
We should have this as a util once.
https://github.com/perses/shared/pull/120/changes#r3309644486
| * markLine (vertical dashed lines) and markPoint (triangle markers under the X-axis). | ||
| */ | ||
| export function buildAnnotationSeries(annotations: TimeSeriesAnnotation[] | undefined): LineSeriesOption[] { | ||
| if (!annotations || annotations.length === 0) return []; |
Contributor
There was a problem hiding this comment.
if (!annotations?.length) return [];| const markPointData: any[] = []; | ||
|
|
||
| annotations.forEach((annotation, index) => { | ||
| const color = annotation.color ?? '#FF6B6B'; |
Contributor
There was a problem hiding this comment.
It seems you have already defined this color-code in plugin-system\src\components\Annotations\AnnotationEditorForm\AnnotationEditorForm.tsx
To avoid duplication the definition could be kept in plugin-system only and exposed so the plugin itself can use it as the default one.
export const DEFAULT_ANNOTATION_COLOR = '#FF6B6B';
Comment on lines
+210
to
+238
| // Add start marker | ||
| markPointData.push({ | ||
| coord: [annotation.start, 0], | ||
| symbol: 'triangle', | ||
| symbolSize: [12, 12], | ||
| symbolRotate: 0, | ||
| symbolOffset: [0, 4], // Position below X-axis | ||
| itemStyle: { color }, | ||
| annotationIndex: index, | ||
| emphasis: { | ||
| disabled: true, | ||
| }, | ||
| isStart: true, | ||
| }); | ||
|
|
||
| // Add end marker | ||
| markPointData.push({ | ||
| coord: [annotation.end, 0], | ||
| symbol: 'triangle', | ||
| symbolSize: [12, 12], | ||
| symbolRotate: 0, | ||
| symbolOffset: [0, 4], // Position below X-axis | ||
| itemStyle: { color }, | ||
| annotationIndex: index, | ||
| emphasis: { | ||
| disabled: true, | ||
| }, | ||
| isEnd: true, | ||
| }); |
Contributor
There was a problem hiding this comment.
This looks cumbersome and could be simplified.
for (const type of ['Start', 'End']) {
const isStart = type === 'Start';
markPointData.push({
coord: [isStart ? annotation.start : annotation.end, 0],
symbol: 'triangle',
symbolSize: [12, 12],
symbolRotate: 0,
symbolOffset: [0, 4],
itemStyle: { color },
annotationIndex: index,
emphasis: { disabled: true },
isStart,
isEnd: !isStart,
});
}
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
Add annotation generation for Prometheus datasource and add display on TimeSeriesChart.
Idea: add option to ignore "end" to only keep a point
PR related to:
Screenshots
Checklist
[<catalog_entry>] <commit message>naming convention using one of thefollowing
catalog_entryvalues:FEATURE,ENHANCEMENT,BUGFIX,BREAKINGCHANGE,DOC,IGNORE.UI Changes