Newer
Older
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
# MetricsEngineServiceApi.MetricsApi
All URIs are relative to *http://127.0.0.1:8086/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**metricsGet**](MetricsApi.md#metricsGet) | **GET** /metrics |
[**metricsGetByDataType**](MetricsApi.md#metricsGetByDataType) | **GET** /metrics/{dataType} |
[**metricsGetByDataTypeByDest**](MetricsApi.md#metricsGetByDataTypeByDest) | **GET** /metrics/{dataType}/{dest} |
[**metricsGetByTypeByDestBySrc**](MetricsApi.md#metricsGetByTypeByDestBySrc) | **GET** /metrics/{dataType}/{dest}/{src} |
<a name="metricsGet"></a>
# **metricsGet**
> InlineResponse200 metricsGet(opts)
Used to get a list of all metrics
### Example
```javascript
var MetricsEngineServiceApi = require('metrics_engine_service_api');
var apiInstance = new MetricsEngineServiceApi.MetricsApi();
var opts = {
'startTime': "startTime_example", // String | Starting timestamp of time range
'stopTime': "stopTime_example" // String | Ending timestamp of time range
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.metricsGet(opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**startTime** | **String**| Starting timestamp of time range | [optional]
**stopTime** | **String**| Ending timestamp of time range | [optional]
### Return type
[**InlineResponse200**](InlineResponse200.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="metricsGetByDataType"></a>
# **metricsGetByDataType**
> DataResponseList metricsGetByDataType(dataType, opts)
Used to get a list of all metrics for a specific message type
### Example
```javascript
var MetricsEngineServiceApi = require('metrics_engine_service_api');
var apiInstance = new MetricsEngineServiceApi.MetricsApi();
var dataType = "dataType_example"; // String | Log Message Type
var opts = {
'startTime': "startTime_example", // String | Starting timestamp of time range
'stopTime': "stopTime_example" // String | Ending timestamp of time range
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.metricsGetByDataType(dataType, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**dataType** | **String**| Log Message Type |
**startTime** | **String**| Starting timestamp of time range | [optional]
**stopTime** | **String**| Ending timestamp of time range | [optional]
### Return type
[**DataResponseList**](DataResponseList.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="metricsGetByDataTypeByDest"></a>
# **metricsGetByDataTypeByDest**
> DataResponseList metricsGetByDataTypeByDest(dataType, dest, opts)
Used to get a list of all metrics for a specific message type and destination pod combination
### Example
```javascript
var MetricsEngineServiceApi = require('metrics_engine_service_api');
var apiInstance = new MetricsEngineServiceApi.MetricsApi();
var dataType = "dataType_example"; // String | Log Message Type
var dest = "dest_example"; // String | Pod where the log message is taken from
var opts = {
'startTime': "startTime_example", // String | Starting timestamp of time range
'stopTime': "stopTime_example" // String | Ending timestamp of time range
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.metricsGetByDataTypeByDest(dataType, dest, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**dataType** | **String**| Log Message Type |
**dest** | **String**| Pod where the log message is taken from |
**startTime** | **String**| Starting timestamp of time range | [optional]
**stopTime** | **String**| Ending timestamp of time range | [optional]
### Return type
[**DataResponseList**](DataResponseList.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
<a name="metricsGetByTypeByDestBySrc"></a>
# **metricsGetByTypeByDestBySrc**
> DataResponseList metricsGetByTypeByDestBySrc(dest, dataType, src, opts)
Used to get a list of all metrics for a specific message type, destination pd and source pod combination
### Example
```javascript
var MetricsEngineServiceApi = require('metrics_engine_service_api');
var apiInstance = new MetricsEngineServiceApi.MetricsApi();
var dest = "dest_example"; // String | Pod where the log message is taken from
var dataType = "dataType_example"; // String | Log Message Type
var src = "src_example"; // String | Pod that originated the metrics logged in the message
var opts = {
'starTime': "starTime_example", // String | Starting timestamp of time range
'stopTime': "stopTime_example" // String | Ending timestamp of time range
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.metricsGetByTypeByDestBySrc(dest, dataType, src, opts, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**dest** | **String**| Pod where the log message is taken from |
**dataType** | **String**| Log Message Type |
**src** | **String**| Pod that originated the metrics logged in the message |
**starTime** | **String**| Starting timestamp of time range | [optional]
**stopTime** | **String**| Ending timestamp of time range | [optional]
### Return type
[**DataResponseList**](DataResponseList.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json