Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat: add labels meta #959

Merged
merged 5 commits into from
Sep 23, 2024
Merged

feat: add labels meta #959

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4ad6e6e
updated examples
shahzad31 Sep 19, 2024
7dfc1de
revert
shahzad31 Sep 19, 2024
200e52f
add unit test
shahzad31 Sep 19, 2024
9e0bc61
rename labels to fields
shahzad31 Sep 20, 2024
fe2dcb8
add more tests
shahzad31 Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/common_types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,7 @@ export type PushOptions = Partial<ProjectSettings> &
kibanaVersion?: string;
yes?: boolean;
tags?: Array<string>;
labels?: Record<string, string>;
Copy link
Member

@vigneshshanmugam vigneshshanmugam Sep 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's rename this to fields to map with the heartbeat top level fields name and under the hood in Kibana, you can map to labels. Having labels as top level is confusing - https://www.elastic.co/guide/en/beats/heartbeat/8.12/configuration-general-options.html#libbeat-configuration-fields

Also let's write JS doc annotation so it's visible on TS config.

alert?: AlertConfig;
retestOnFailure?: MonitorConfig['retestOnFailure'];
enabled?: boolean;
Expand Down
1 change: 1 addition & 0 deletions src/dsl/monitor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ export type MonitorConfig = {
name?: string;
type?: string;
tags?: string[];
labels?: Record<string, string>;
schedule?: typeof ALLOWED_SCHEDULES[number];
enabled?: boolean;
locations?: SyntheticsLocationsType[];
Expand Down
20 changes: 20 additions & 0 deletions src/push/monitor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,7 @@ export function buildMonitorFromYaml(
enabled: config.enabled ?? options.enabled,
locations: options.locations,
tags: options.tags,
labels: parseLabels(config, options.labels),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add this new field to some of the unit tests validating lightweight monitors

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i have added here 200e52f (#959)

...normalizeConfig(config),
retestOnFailure,
privateLocations,
Expand Down Expand Up @@ -311,6 +312,25 @@ export const parseAlertConfig = (
return Object.keys(result).length > 0 ? result : undefined;
};

export const parseLabels = (
config: MonitorConfig,
gLabels?: Record<string, string>
) => {
// get all keys starting with `label.`
const keys = Object.keys(config).filter(key => key.startsWith('labels.'));
const labels = {};
for (const key of keys) {
labels[key.replace('labels.', '')] = config[key];
delete config[key];
}
if (gLabels) {
for (const key of Object.keys(gLabels)) {
labels[key] = gLabels[key];
}
}
return Object.keys(labels).length > 0 ? labels : undefined;
};

export function getAlertKeyValue(
key: 'status' | 'tls',
config: MonitorConfig,
Expand Down