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
|
// Copyright 2015 opentsdb-goclient authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
//
// Package client defines the client and the corresponding
// rest api implementaion of OpenTSDB.
//
// query_last.go contains the structs and methods for the implementation of /api/query/last,
// which is fully supported since v2.2 of opentsdb.
//
package client
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"strings"
)
// QueryLastParam is the structure used to hold
// the querying parameters when calling /api/query/last.
// Each attributes in QueryLastParam matches the definition in
// (http://opentsdb.net/docs/build/html/api_http/query/last.html).
//
type QueryLastParam struct {
// One or more sub queries used to select the time series to return.
// These may be metric m or TSUID tsuids queries
// The value is required with at least one element
Queries []SubQueryLast `json:"queries"`
// An optional flag is used to determine whether or not to resolve the TSUIDs of results to
// their metric and tag names. The default value is false.
ResolveNames bool `json:"resolveNames"`
// An optional number of hours is used to search in the past for data. If set to 0 then the
// timestamp of the meta data counter for the time series is used.
BackScan int `json:"backScan"`
}
func (query *QueryLastParam) String() string {
content, _ := json.Marshal(query)
return string(content)
}
// SubQueryLast is the structure used to hold
// the subquery parameters when calling /api/query/last.
// Each attributes in SubQueryLast matches the definition in
// (http://opentsdb.net/docs/build/html/api_http/query/last.html).
//
type SubQueryLast struct {
// The name of a metric stored in the system.
// The value is reqiured with non-empty value.
Metric string `json:"metric"`
// An optional value to drill down to specific timeseries or group results by tag,
// supply one or more map values in the same format as the query string. Tags are converted to filters in 2.2.
// Note that if no tags are specified, all metrics in the system will be aggregated into the results.
// It will be deprecated in OpenTSDB 2.2.
Tags map[string]string `json:"tags,omitempty"`
}
// QueryLastResponse acts as the implementation of Response in the /api/query/last scene.
// It holds the status code and the response values defined in the
// (http://opentsdb.net/docs/build/html/api_http/query/last.html).
//
type QueryLastResponse struct {
StatusCode int
QueryRespCnts []QueryRespLastItem `json:"queryRespCnts,omitempty"`
ErrorMsg map[string]interface{} `json:"error"`
}
func (queryLastResp *QueryLastResponse) String() string {
buffer := bytes.NewBuffer(nil)
content, _ := json.Marshal(queryLastResp)
buffer.WriteString(fmt.Sprintf("%s\n", string(content)))
return buffer.String()
}
func (queryLastResp *QueryLastResponse) SetStatus(code int) {
queryLastResp.StatusCode = code
}
func (queryLastResp *QueryLastResponse) GetCustomParser() func(respCnt []byte) error {
return func(respCnt []byte) error {
originRespStr := string(respCnt)
var respStr string
if queryLastResp.StatusCode == 200 && strings.Contains(originRespStr, "[") && strings.Contains(originRespStr, "]") {
respStr = fmt.Sprintf("{%s:%s}", `"queryRespCnts"`, originRespStr)
} else {
respStr = originRespStr
}
return json.Unmarshal([]byte(respStr), &queryLastResp)
}
}
// QueryRespLastItem acts as the implementation of Response in the /api/query/last scene.
// It holds the response item defined in the
// (http://opentsdb.net/docs/build/html/api_http/query/last.html).
//
type QueryRespLastItem struct {
// Name of the metric retreived for the time series.
// Only returned if resolve was set to true.
Metric string `json:"metric"`
// A list of tags only returned when the results are for a single time series.
// If results are aggregated, this value may be null or an empty map.
// Only returned if resolve was set to true.
Tags map[string]string `json:"tags"`
// A Unix epoch timestamp, in milliseconds, when the data point was written.
Timestamp int64 `json:"timestamp"`
// The value of the data point enclosed in quotation marks as a string
Value string `json:"value"`
// The hexadecimal TSUID for the time series
Tsuid string `json:"tsuid"`
}
func (c *clientImpl) QueryLast(param QueryLastParam) (*QueryLastResponse, error) {
if !isValidQueryLastParam(¶m) {
return nil, errors.New("The given query param is invalid.\n")
}
queryEndpoint := fmt.Sprintf("%s%s", c.tsdbEndpoint, QueryLastPath)
reqBodyCnt, err := getQueryBodyContents(¶m)
if err != nil {
return nil, err
}
queryResp := QueryLastResponse{}
if err = c.sendRequest(PostMethod, queryEndpoint, reqBodyCnt, &queryResp); err != nil {
return nil, err
}
return &queryResp, nil
}
func isValidQueryLastParam(param *QueryLastParam) bool {
if param.Queries == nil || len(param.Queries) == 0 {
return false
}
for _, query := range param.Queries {
if len(query.Metric) == 0 {
return false
}
}
return true
}
|
