telemetry_broker/settings-controller.yaml at master · Romanchenko/telemetry_broker · GitHub

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
openapi: "3.0.0"
info:
  version: "1.0"
  title: "BifrostController"
  description: Will send your metrics to valhalla
paths:
  /settings/export/enable:
    post:
      operationId: GlobalExportEnable
      responses:
        200:
          description: "OK"

  /settings/export/disable:
    post:
      operationId: GlobalExportDisable
      responses:
        200:
          description: "OK"

  /settings/export/rule:
    post:
      operationId: AddRule
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Rule"

  /settings/export/rule/{ruleId}:
    get:
      parameters:
        - in: path
          name: ruleId
          schema:
            type: string
          required: true
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Rule"


  /settings/clickhouse:
    post:
      operationId: ChangeClickouseConnection
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ClickHouseSettingsRequest"
      responses:
        200:
          description: "OK"


  /info/clickhouse/system:
    get:
      operationId: ClickHouseSystemStats
      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ClickHouseStats"

  /info/clickhouse/redundant_metrics:
    get:
      operationId: ClickHouseMetricsStorage
      description: Get metrics, that tend to be constant and therefore are unnecessary for export
      parameters:
        - in: query
          name: active
          description: get stats for metrics with enabled (active=true) export or with disabled (active=false)
          schema:
            type: boolean
            default: true

        - in: query
          name: count
          description: how many items should be returned in suggest
          schema:
            type: number
            default: 5
        - in: query
          name: window
          description: window size to evaluate standard deviation
          schema:
            type: number
            default: 100

        - in: query
          name: threshold
          description: the maximum value of standard deviation to suggest metric for removal
          schema:
            type: number
            default: 0.01

      responses:
        200:
          description: "OK"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/RedundantMetricsResponse"

components:

  schemas:

    ClickHouseStats:
      type: object
      properties:
        cpuUsage:
          type: string
        diskFreeBytes:
          type: number


    ClickHouseSettingsRequest:
      type: object
      properties:
        connectionString:
          type: string
        connectionPort:
          type: number
        user:
          type: string
        password:
          type: string

    Rule:
      type: object
      properties:
        ruleId:
          type: string
        path:
          type: string
        port:
          type: number
        endpoint:
          type: string
        namespace:
          type: string
      required:
        - ruleId
        - path
        - port
        - endpoint

    RedundantMetric:
      type: object
      properties:
        metricName:
          type: string
        stddev:
          type: number
        absdif:
          type: number


    RedundantMetricsResponse:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: "#/components/schemas/RedundantMetric"