forked from netdata/netdata
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathnetdata-swagger.yaml
1414 lines (1414 loc) · 47.1 KB
/
netdata-swagger.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: NetData API
description: Real-time performance and health monitoring.
version: 1.11.1_rolling
paths:
/info:
get:
summary: Get netdata basic information
description: |
The info endpoint returns basic information about netdata. It provides:
* netdata version
* netdata unique id
* list of hosts mirrored (includes itself)
* Operating System, Virtualization and Container technology information
* List of active collector plugins and modules
* number of alarms in the host
* number of alarms in normal state
* number of alarms in warning state
* number of alarms in critical state
responses:
"200":
description: netdata basic information.
content:
application/json:
schema:
$ref: "#/components/schemas/info"
"503":
description: netdata daemon not ready (used for health checks).
/charts:
get:
summary: Get a list of all charts available at the server
description: The charts endpoint returns a summary about all charts stored in the
netdata server.
responses:
"200":
description: An array of charts.
content:
application/json:
schema:
$ref: "#/components/schemas/chart_summary"
/chart:
get:
summary: Get info about a specific chart
description: The Chart endpoint returns detailed information about a chart.
parameters:
- name: chart
in: query
description: The id of the chart as returned by the /charts call.
required: true
schema:
type: string
format: as returned by /charts
default: system.cpu
responses:
"200":
description: A javascript object with detailed information about the chart.
content:
application/json:
schema:
$ref: "#/components/schemas/chart"
"400":
description: No chart id was supplied in the request.
"404":
description: No chart with the given id is found.
/alarm_variables:
get:
summary: List variables available to configure alarms for a chart
description: Returns the basic information of a chart and all the variables that can
be used in alarm and template health configurations for the particular
chart or family.
parameters:
- name: chart
in: query
description: The id of the chart as returned by the /charts call.
required: true
schema:
type: string
format: as returned by /charts
default: system.cpu
responses:
"200":
description: A javascript object with information about the chart and the
available variables.
content:
application/json:
schema:
$ref: "#/components/schemas/alarm_variables"
"400":
description: Bad request - the body will include a message stating what is wrong.
"404":
description: No chart with the given id is found.
"500":
description: Internal server error. This usually means the server is out of
memory.
/data:
get:
summary: Get collected data for a specific chart
description: The data endpoint returns data stored in the round robin database of a
chart.
parameters:
- name: chart
in: query
description: The id of the chart as returned by the /charts call.
required: true
allowEmptyValue: false
schema:
type: string
format: as returned by /charts
default: system.cpu
- name: dimension
in: query
description: Zero, one or more dimension ids or names, as returned by the /chart
call, separated with comma or pipe. Netdata simple patterns are
supported.
required: false
allowEmptyValue: false
schema:
type: array
items:
type: string
format: as returned by /charts
- name: after
in: query
description: "This parameter can either be an absolute timestamp specifying the
starting point of the data to be returned, or a relative number of
seconds (negative, relative to parameter: before). Netdata will
assume it is a relative number if it is less that 3 years (in
seconds). Netdata will adapt this parameter to the boundaries of the
round robin database. The default is the beginning of the round
robin database (i.e. by default netdata will attempt to return data
for the entire database)."
required: true
allowEmptyValue: false
schema:
type: number
format: integer
default: -600
- name: before
in: query
description: This parameter can either be an absolute timestamp specifying the
ending point of the data to be returned, or a relative number of
seconds (negative), relative to the last collected timestamp.
Netdata will assume it is a relative number if it is less than 3
years (in seconds). Netdata will adapt this parameter to the
boundaries of the round robin database. The default is zero (i.e.
the timestamp of the last value collected).
required: false
schema:
type: number
format: integer
default: 0
- name: points
in: query
description: The number of points to be returned. If not given, or it is <= 0, or
it is bigger than the points stored in the round robin database for
this chart for the given duration, all the available collected
values for the given duration will be returned.
required: true
allowEmptyValue: false
schema:
type: number
format: integer
default: 20
- name: group
in: query
description: The grouping method. If multiple collected values are to be grouped
in order to return fewer points, this parameters defines the method
of grouping. methods supported "min", "max", "average", "sum",
"incremental-sum". "max" is actually calculated on the absolute
value collected (so it works for both positive and negative
dimesions to return the most extreme value in either direction).
required: true
allowEmptyValue: false
schema:
type: string
enum:
- min
- max
- average
- median
- stddev
- sum
- incremental-sum
default: average
- name: gtime
in: query
description: The grouping number of seconds. This is used in conjunction with
group=average to change the units of metrics (ie when the data is
per-second, setting gtime=60 will turn them to per-minute).
required: false
allowEmptyValue: false
schema:
type: number
format: integer
default: 0
- name: format
in: query
description: The format of the data to be returned.
required: true
allowEmptyValue: false
schema:
type: string
enum:
- json
- jsonp
- csv
- tsv
- tsv-excel
- ssv
- ssvcomma
- datatable
- datasource
- html
- markdown
- array
- csvjsonarray
default: json
- name: options
in: query
description: Options that affect data generation.
required: false
allowEmptyValue: false
schema:
type: array
items:
type: string
enum:
- nonzero
- flip
- jsonwrap
- min2max
- seconds
- milliseconds
- abs
- absolute
- absolute-sum
- null2zero
- objectrows
- google_json
- percentage
- unaligned
- match-ids
- match-names
- showcustomvars
default:
- seconds
- jsonwrap
- name: callback
in: query
description: For JSONP responses, the callback function name.
required: false
allowEmptyValue: true
schema:
type: string
- name: filename
in: query
description: "Add Content-Disposition: attachment; filename= header to
the response, that will instruct the browser to save the response
with the given filename."
required: false
allowEmptyValue: true
schema:
type: string
- name: tqx
in: query
description: "[Google Visualization
API](https://developers.google.com/chart/interactive/docs/dev/imple\
menting_data_source?hl=en) formatted parameter."
required: false
allowEmptyValue: true
schema:
type: string
responses:
"200":
description: The call was successful. The response includes the data in the
format requested. Swagger2.0 does not process the discriminator
field to show polymorphism. The response will be one of the
sub-types of the data-schema according to the chosen format, e.g.
json -> data_json.
content:
application/json:
schema:
$ref: "#/components/schemas/data"
"400":
description: Bad request - the body will include a message stating what is wrong.
"404":
description: No chart with the given id is found.
"500":
description: Internal server error. This usually means the server is out of
memory.
/badge.svg:
get:
summary: Generate a SVG image for a chart (or dimension)
description: Successful responses are SVG images.
parameters:
- name: chart
in: query
description: The id of the chart as returned by the /charts call.
required: true
allowEmptyValue: false
schema:
type: string
format: as returned by /charts
default: system.cpu
- name: alarm
in: query
description: The name of an alarm linked to the chart.
required: false
allowEmptyValue: true
schema:
type: string
format: any text
- name: dimension
in: query
description: Zero, one or more dimension ids, as returned by the /chart call.
required: false
allowEmptyValue: false
schema:
type: array
items:
type: string
format: as returned by /charts
- name: after
in: query
description: This parameter can either be an absolute timestamp specifying the
starting point of the data to be returned, or a relative number of
seconds, to the last collected timestamp. Netdata will assume it is
a relative number if it is smaller than the duration of the round
robin database for this chart. So, if the round robin database is
3600 seconds, any value from -3600 to 3600 will trigger relative
arithmetics. Netdata will adapt this parameter to the boundaries of
the round robin database.
required: true
allowEmptyValue: false
schema:
type: number
format: integer
default: -600
- name: before
in: query
description: This parameter can either be an absolute timestamp specifying the
ending point of the data to be returned, or a relative number of
seconds, to the last collected timestamp. Netdata will assume it is
a relative number if it is smaller than the duration of the round
robin database for this chart. So, if the round robin database is
3600 seconds, any value from -3600 to 3600 will trigger relative
arithmetics. Netdata will adapt this parameter to the boundaries of
the round robin database.
required: false
schema:
type: number
format: integer
default: 0
- name: group
in: query
description: The grouping method. If multiple collected values are to be grouped
in order to return fewer points, this parameters defines the method
of grouping. methods are supported "min", "max", "average", "sum",
"incremental-sum". "max" is actually calculated on the absolute
value collected (so it works for both positive and negative
dimesions to return the most extreme value in either direction).
required: true
allowEmptyValue: false
schema:
type: string
enum:
- min
- max
- average
- median
- stddev
- sum
- incremental-sum
default: average
- name: options
in: query
description: Options that affect data generation.
required: false
allowEmptyValue: true
schema:
type: array
items:
type: string
enum:
- abs
- absolute
- display-absolute
- absolute-sum
- null2zero
- percentage
- unaligned
default:
- absolute
- name: label
in: query
description: A text to be used as the label.
required: false
allowEmptyValue: true
schema:
type: string
format: any text
- name: units
in: query
description: A text to be used as the units.
required: false
allowEmptyValue: true
schema:
type: string
format: any text
- name: label_color
in: query
description: A color to be used for the background of the label.
required: false
allowEmptyValue: true
schema:
type: string
format: any text
- name: value_color
in: query
description: "A color to be used for the background of the label. You can set
multiple using a pipe with a condition each, like this:
colorvalue|color:null The following operators are
supported: >, <, >=, <=, =, :null (to check if no value exists)."
required: false
allowEmptyValue: true
schema:
type: string
format: any text
- name: multiply
in: query
description: Multiply the value with this number for rendering it at the image
(integer value required).
required: false
allowEmptyValue: true
schema:
type: number
format: integer
- name: divide
in: query
description: Divide the value with this number for rendering it at the image
(integer value required).
required: false
allowEmptyValue: true
schema:
type: number
format: integer
- name: scale
in: query
description: Set the scale of the badge (greater or equal to 100).
required: false
allowEmptyValue: true
schema:
type: number
format: integer
responses:
"200":
description: The call was successful. The response should be an SVG image.
"400":
description: Bad request - the body will include a message stating what is wrong.
"404":
description: No chart with the given id is found.
"500":
description: Internal server error. This usually means the server is out of
memory.
/allmetrics:
get:
summary: Get a value of all the metrics maintained by netdata
description: The allmetrics endpoint returns the latest value of all charts and
dimensions stored in the netdata server.
parameters:
- name: format
in: query
description: The format of the response to be returned.
required: true
schema:
type: string
enum:
- shell
- prometheus
- prometheus_all_hosts
- json
default: shell
- name: help
in: query
description: Enable or disable HELP lines in prometheus output.
required: false
schema:
type: string
enum:
- yes
- no
default: no
- name: types
in: query
description: Enable or disable TYPE lines in prometheus output.
required: false
schema:
type: string
enum:
- yes
- no
default: no
- name: timestamps
in: query
description: Enable or disable timestamps in prometheus output.
required: false
schema:
type: string
enum:
- yes
- no
default: yes
- name: names
in: query
description: When enabled netdata will report dimension names. When disabled
netdata will report dimension IDs. The default is controlled in
netdata.conf.
required: false
schema:
type: string
enum:
- yes
- no
default: yes
- name: oldunits
in: query
description: When enabled, netdata will show metric names for the default
source=average as they appeared before 1.12, by using the legacy
unit naming conventions.
required: false
schema:
type: string
enum:
- yes
- no
default: yes
- name: hideunits
in: query
description: When enabled, netdata will not include the units in the metric
names, for the default source=average.
required: false
schema:
type: string
enum:
- yes
- no
default: yes
- name: server
in: query
description: Set a distinct name of the client querying prometheus metrics.
Netdata will use the client IP if this is not set.
required: false
schema:
type: string
format: any text
- name: prefix
in: query
description: Prefix all prometheus metrics with this string.
required: false
schema:
type: string
format: any text
- name: data
in: query
description: Select the prometheus response data source. There is a setting in
netdata.conf for the default.
required: false
schema:
type: string
enum:
- as-collected
- average
- sum
default: average
responses:
"200":
description: All the metrics returned in the format requested.
"400":
description: The format requested is not supported.
/alarms:
get:
summary: Get a list of active or raised alarms on the server
description: The alarms endpoint returns the list of all raised or enabled alarms on
the netdata server. Called without any parameters, the raised alarms in
state WARNING or CRITICAL are returned. By passing "?all", all the
enabled alarms are returned.
parameters:
- name: all
in: query
description: If passed, all enabled alarms are returned.
required: false
allowEmptyValue: true
schema:
type: boolean
responses:
"200":
description: An object containing general info and a linked list of alarms.
content:
application/json:
schema:
$ref: "#/components/schemas/alarms"
/alarm_log:
get:
summary: Retrieves the entries of the alarm log
description: Returns an array of alarm_log entries, with historical information on
raised and cleared alarms.
parameters:
- name: after
in: query
description: Passing the parameter after=UNIQUEID returns all the events in the
alarm log that occurred after UNIQUEID. An automated series of calls
would call the interface once without after=, store the last
UNIQUEID of the returned set, and give it back to get incrementally
the next events.
required: false
schema:
type: integer
responses:
"200":
description: An array of alarm log entries.
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/alarm_log_entry"
/alarm_count:
get:
summary: Get an overall status of the chart
description: Checks multiple charts with the same context and counts number of alarms
with given status.
parameters:
- in: query
name: context
description: Specify context which should be checked.
required: false
allowEmptyValue: true
schema:
type: array
items:
type: string
default:
- system.cpu
- in: query
name: status
description: Specify alarm status to count.
required: false
allowEmptyValue: true
schema:
type: string
enum:
- REMOVED
- UNDEFINED
- UNINITIALIZED
- CLEAR
- RAISED
- WARNING
- CRITICAL
default: RAISED
responses:
"200":
description: An object containing a count of alarms with given status for given
contexts.
content:
application/json:
schema:
type: array
items:
type: number
"500":
description: Internal server error. This usually means the server is out of
memory.
/manage/health:
get:
summary: Accesses the health management API to control health checks and
notifications at runtime.
description: Available from Netdata v1.12 and above, protected via bearer
authorization. Especially useful for maintenance periods, the API allows
you to disable health checks completely, silence alarm notifications, or
Disable/Silence specific alarms that match selectors on alarm/template
name, chart, context, host and family. For the simple disable/silence
all scenaria, only the cmd parameter is required. The other parameters
are used to define alarm selectors. For more information and examples,
refer to the netdata documentation.
parameters:
- name: cmd
in: query
description: "DISABLE ALL: No alarm criteria are evaluated, nothing is written in
the alarm log. SILENCE ALL: No notifications are sent. RESET: Return
to the default state. DISABLE/SILENCE: Set the mode to be used for
the alarms matching the criteria of the alarm selectors. LIST: Show
active configuration."
required: false
schema:
type: string
enum:
- DISABLE ALL
- SILENCE ALL
- DISABLE
- SILENCE
- RESET
- LIST
- name: alarm
in: query
description: The expression provided will match both `alarm` and `template` names.
schema:
type: string
- name: chart
in: query
description: Chart ids/names, as shown on the dashboard. These will match the
`on` entry of a configured `alarm`.
schema:
type: string
- name: context
in: query
description: Chart context, as shown on the dashboard. These will match the `on`
entry of a configured `template`.
schema:
type: string
- name: hosts
in: query
description: The hostnames that will need to match.
schema:
type: string
- name: families
in: query
description: The alarm families.
schema:
type: string
responses:
"200":
description: A plain text response based on the result of the command.
"403":
description: Bearer authentication error.
servers:
- url: https://registry.my-netdata.io/api/v1
- url: http://registry.my-netdata.io/api/v1
components:
schemas:
info:
type: object
properties:
version:
type: string
description: netdata version of the server.
example: 1.11.1_rolling
uid:
type: string
description: netdata unique id of the server.
example: 24e9fe3c-f2ac-11e8-bafc-0242ac110002
mirrored_hosts:
type: array
description: List of hosts mirrored of the server (include itself).
items:
type: string
example:
- host1.example.com
- host2.example.com
os_name:
type: string
description: Operating System Name.
example: Manjaro Linux
os_id:
type: string
description: Operating System ID.
example: manjaro
os_id_like:
type: string
description: Known OS similar to this OS.
example: arch
os_version:
type: string
description: Operating System Version.
example: 18.0.4
os_version_id:
type: string
description: Operating System Version ID.
example: unknown
os_detection:
type: string
description: OS parameters detection method.
example: Mixed
kernel_name:
type: string
description: Kernel Name.
example: Linux
kernel_version:
type: string
description: Kernel Version.
example: 4.19.32-1-MANJARO
architecture:
type: string
description: Kernel architecture.
example: x86_64
virtualization:
type: string
description: Virtualization Type.
example: kvm
virt_detection:
type: string
description: Virtualization detection method.
example: systemd-detect-virt
container:
type: string
description: Container technology.
example: docker
container_detection:
type: string
description: Container technology detection method.
example: dockerenv
collectors:
type: array
items:
type: object
description: Array of collector plugins and modules.
properties:
plugin:
type: string
description: Collector plugin.
example: python.d.plugin
module:
type: string
description: Module of the collector plugin.
example: dockerd
alarms:
type: object
description: Number of alarms in the server.
properties:
normal:
type: integer
description: Number of alarms in normal state.
warning:
type: integer
description: Number of alarms in warning state.
critical:
type: integer
description: Number of alarms in critical state.
chart_summary:
type: object
properties:
hostname:
type: string
description: The hostname of the netdata server.
version:
type: string
description: netdata version of the server.
release_channel:
type: string
description: The release channel of the build on the server.
example: nightly
timezone:
type: string
description: The current timezone on the server.
os:
type: string
description: The netdata server host operating system.
enum:
- macos
- linux
- freebsd
history:
type: number
description: The duration, in seconds, of the round robin database maintained by
netdata.
memory_mode:
type: string
description: The name of the database memory mode on the server.
update_every:
type: number
description: The default update frequency of the netdata server. All charts have
an update frequency equal or bigger than this.
charts:
type: object
description: An object containing all the chart objects available at the netdata
server. This is used as an indexed array. The key of each chart
object is the id of the chart.
additionalProperties:
$ref: "#/components/schemas/chart"
charts_count:
type: number
description: The number of charts.
dimensions_count:
type: number
description: The total number of dimensions.
alarms_count:
type: number
description: The number of alarms.
rrd_memory_bytes:
type: number
description: The size of the round robin database in bytes.
chart:
type: object
properties:
id:
type: string
description: The unique id of the chart.
name:
type: string
description: The name of the chart.
type:
type: string
description: The type of the chart. Types are not handled by netdata. You can use
this field for anything you like.
family:
type: string
description: The family of the chart. Families are not handled by netdata. You
can use this field for anything you like.
title:
type: string
description: The title of the chart.
priority:
type: number
description: The relative priority of the chart. NetData does not care about
priorities. This is just an indication of importance for the chart
viewers to sort charts of higher priority (lower number) closer to
the top. Priority sorting should only be used among charts of the
same type or family.
enabled:
type: boolean
description: True when the chart is enabled. Disabled charts do not currently
collect values, but they may have historical values available.
units:
type: string
description: The unit of measurement for the values of all dimensions of the
chart.
data_url:
type: string
description: The absolute path to get data values for this chart. You are
expected to use this path as the base when constructing the URL to
fetch data values for this chart.
chart_type:
type: string
description: The chart type.
enum:
- line
- area
- stacked
duration:
type: number
description: The duration, in seconds, of the round robin database maintained by
netdata.
first_entry:
type: number
description: The UNIX timestamp of the first entry (the oldest) in the round
robin database.
last_entry:
type: number
description: The UNIX timestamp of the latest entry in the round robin database.
update_every:
type: number
description: The update frequency of this chart, in seconds. One value every this
amount of time is kept in the round robin database.
dimensions:
type: object
description: "An object containing all the chart dimensions available for the
chart. This is used as an indexed array. For each pair in the
dictionary: the key is the id of the dimension and the value is a
dictionary containing the name."
additionalProperties:
type: object
properties:
name:
type: string
description: The name of the dimension
chart_variables:
type: object
additionalProperties:
$ref: "#/components/schemas/chart_variables"
green:
type: number
nullable: true
description: Chart health green threshold.
red:
type: number
nullable: true
description: Chart health red threshold.
alarm_variables:
type: object
properties:
chart:
type: string
description: The unique id of the chart.
chart_name:
type: string
description: The name of the chart.
cnart_context:
type: string
description: The context of the chart. It is shared across multiple monitored
software or hardware instances and used in alarm templates.
family:
type: string
description: The family of the chart.
host:
type: string
description: The host containing the chart.
chart_variables:
type: object
additionalProperties:
$ref: "#/components/schemas/chart_variables"