pax_global_header00006660000000000000000000000064126770111010014506gustar00rootroot0000000000000052 comment=50f4099dfd739f913ed7d8f33288aeeca338516a hawkular-client-go-0.6.0/000077500000000000000000000000001267701110100152065ustar00rootroot00000000000000hawkular-client-go-0.6.0/.gitignore000066400000000000000000000004311267701110100171740ustar00rootroot00000000000000# Compiled Object files, Static and Dynamic libs (Shared Objects) *.o *.a *.so # Folders _obj _test # Architecture specific extensions/prefixes *.[568vq] [568vq].out *.cgo1.go *.cgo2.c _cgo_defun.c _cgo_gotypes.go _cgo_export.* _testmain.go *.exe *.test *.prof # Emacs *~ \#*hawkular-client-go-0.6.0/LICENSE000066400000000000000000000261361267701110100162230ustar00rootroot00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} 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. hawkular-client-go-0.6.0/README.adoc000066400000000000000000000012101267701110100167650ustar00rootroot00000000000000.... Copyright 2015-2016 Red Hat, Inc. and/or its affiliates and other contributors. 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. .... hawkular-client-go-0.6.0/metrics/000077500000000000000000000000001267701110100166545ustar00rootroot00000000000000hawkular-client-go-0.6.0/metrics/client.go000066400000000000000000000325151267701110100204670ustar00rootroot00000000000000/* Copyright 2015-2016 Red Hat, Inc. and/or its affiliates and other contributors. 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 metrics import ( "bytes" "encoding/json" "fmt" "io/ioutil" "net/http" "net/url" "strconv" "strings" "sync" "time" ) // TODO Instrumentation? To get statistics? func (c *HawkularClientError) Error() string { return fmt.Sprintf("Hawkular returned status code %d, error message: %s", c.Code, c.msg) } // Client creation and instance config const ( baseURL string = "hawkular/metrics" defaultConcurrency int = 1 timeout time.Duration = time.Duration(30 * time.Second) ) // Tenant Override function to replace the Tenant (defaults to Client default) func Tenant(tenant string) Modifier { return func(r *http.Request) error { r.Header.Set("Hawkular-Tenant", tenant) return nil } } // Data Add payload to the request func Data(data interface{}) Modifier { return func(r *http.Request) error { jsonb, err := json.Marshal(data) if err != nil { return err } b := bytes.NewBuffer(jsonb) rc := ioutil.NopCloser(b) r.Body = rc // fmt.Printf("Sending: %s\n", string(jsonb)) if b != nil { r.ContentLength = int64(b.Len()) } return nil } } // URL Set the request URL func (c *Client) Url(method string, e ...Endpoint) Modifier { // TODO Create composite URLs? Add().Add().. etc? Easier to modify on the fly.. return func(r *http.Request) error { u := c.createURL(e...) r.URL = u r.Method = method return nil } } // Filters Multiple Filter types to execute func Filters(f ...Filter) Modifier { return func(r *http.Request) error { for _, filter := range f { filter(r) } return nil // Or should filter return err? } } // Param Add query parameters func Param(k string, v string) Filter { return func(r *http.Request) { q := r.URL.Query() q.Set(k, v) r.URL.RawQuery = q.Encode() } } // TypeFilter Query parameter filtering with type func TypeFilter(t MetricType) Filter { return Param("type", t.shortForm()) } // TagsFilter Query parameter filtering with tags func TagsFilter(t map[string]string) Filter { j := tagsEncoder(t) return Param("tags", j) } // IdFilter Query parameter to add filtering by id name func IdFilter(regexp string) Filter { return Param("id", regexp) } // StartTimeFilter Query parameter to filter with start time func StartTimeFilter(startTime time.Time) Filter { return Param("start", strconv.Itoa(int(startTime.Unix()))) } // EndTimeFilter Query parameter to filter with end time func EndTimeFilter(endTime time.Time) Filter { return Param("end", strconv.Itoa(int(endTime.Unix()))) } // BucketsFilter Query parameter to define amount of buckets func BucketsFilter(buckets int) Filter { return Param("buckets", strconv.Itoa(buckets)) } // LimitFilter Query parameter to limit result count func LimitFilter(limit int) Filter { return Param("limit", strconv.Itoa(limit)) } // OrderFilter Query parameter to define the ordering of datapoints func OrderFilter(order Order) Filter { return Param("order", order.String()) } // StartFromBeginningFilter Return data from the oldest stored datapoint func StartFromBeginningFilter() Filter { return Param("fromEarliest", "true") } // StackedFilter Force downsampling of stacked return values func StackedFilter() Filter { return Param("stacked", "true") } // PercentilesFilter Query parameter to define the requested percentiles func PercentilesFilter(percentiles []float64) Filter { s := make([]string, 0, len(percentiles)) for _, v := range percentiles { s = append(s, fmt.Sprintf("%v", v)) } j := strings.Join(s, ",") return Param("percentiles", j) } // The SEND method.. func (c *Client) createRequest() *http.Request { req := &http.Request{ Proto: "HTTP/1.1", ProtoMajor: 1, ProtoMinor: 1, Header: make(http.Header), Host: c.url.Host, } req.Header.Add("Content-Type", "application/json") req.Header.Add("Hawkular-Tenant", c.Tenant) if len(c.Token) > 0 { req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", c.Token)) } return req } // Send Sends a constructed request to the Hawkular-Metrics server func (c *Client) Send(o ...Modifier) (*http.Response, error) { // Initialize r := c.createRequest() // Run all the modifiers for _, f := range o { err := f(r) if err != nil { return nil, err } } rChan := make(chan *poolResponse) preq := &poolRequest{r, rChan} c.pool <- preq presp := <-rChan close(rChan) return presp.resp, presp.err } // Commands // Create Creates new metric Definition func (c *Client) Create(md MetricDefinition, o ...Modifier) (bool, error) { // Keep the order, add custom prepend o = prepend(o, c.Url("POST", TypeEndpoint(md.Type)), Data(md)) r, err := c.Send(o...) if err != nil { return false, err } defer r.Body.Close() if r.StatusCode > 399 { err = c.parseErrorResponse(r) if err, ok := err.(*HawkularClientError); ok { if err.Code != http.StatusConflict { return false, err } else { return false, nil } } return false, err } return true, nil } // Definitions Fetch metric definitions func (c *Client) Definitions(o ...Modifier) ([]*MetricDefinition, error) { o = prepend(o, c.Url("GET", TypeEndpoint(Generic))) r, err := c.Send(o...) if err != nil { return nil, err } defer r.Body.Close() if r.StatusCode == http.StatusOK { b, err := ioutil.ReadAll(r.Body) if err != nil { return nil, err } md := []*MetricDefinition{} if b != nil { if err = json.Unmarshal(b, &md); err != nil { return nil, err } } return md, err } else if r.StatusCode > 399 { return nil, c.parseErrorResponse(r) } return nil, nil } // Definition Return a single definition func (c *Client) Definition(t MetricType, id string, o ...Modifier) (*MetricDefinition, error) { o = prepend(o, c.Url("GET", TypeEndpoint(t), SingleMetricEndpoint(id))) r, err := c.Send(o...) if err != nil { return nil, err } defer r.Body.Close() if r.StatusCode == http.StatusOK { b, err := ioutil.ReadAll(r.Body) if err != nil { return nil, err } md := &MetricDefinition{} if b != nil { if err = json.Unmarshal(b, md); err != nil { return nil, err } } return md, err } else if r.StatusCode > 399 { return nil, c.parseErrorResponse(r) } return nil, nil } // UpdateTags Update tags of a metric (or create if not existing) func (c *Client) UpdateTags(t MetricType, id string, tags map[string]string, o ...Modifier) error { o = prepend(o, c.Url("PUT", TypeEndpoint(t), SingleMetricEndpoint(id), TagEndpoint()), Data(tags)) r, err := c.Send(o...) if err != nil { return err } defer r.Body.Close() if r.StatusCode > 399 { return c.parseErrorResponse(r) } return nil } // DeleteTags Delete given tags from the definition func (c *Client) DeleteTags(t MetricType, id string, tags map[string]string, o ...Modifier) error { o = prepend(o, c.Url("DELETE", TypeEndpoint(t), SingleMetricEndpoint(id), TagEndpoint(), TagsEndpoint(tags))) r, err := c.Send(o...) if err != nil { return err } defer r.Body.Close() if r.StatusCode > 399 { return c.parseErrorResponse(r) } return nil } // Tags Fetch metric definition's tags func (c *Client) Tags(t MetricType, id string, o ...Modifier) (map[string]string, error) { o = prepend(o, c.Url("GET", TypeEndpoint(t), SingleMetricEndpoint(id), TagEndpoint())) r, err := c.Send(o...) if err != nil { return nil, err } defer r.Body.Close() if r.StatusCode == http.StatusOK { b, err := ioutil.ReadAll(r.Body) if err != nil { return nil, err } tags := make(map[string]string) if b != nil { if err = json.Unmarshal(b, &tags); err != nil { return nil, err } } return tags, nil } else if r.StatusCode > 399 { return nil, c.parseErrorResponse(r) } return nil, nil } // Write Write datapoints to the server func (c *Client) Write(metrics []MetricHeader, o ...Modifier) error { if len(metrics) > 0 { mHs := make(map[MetricType][]MetricHeader) for _, m := range metrics { if _, found := mHs[m.Type]; !found { mHs[m.Type] = make([]MetricHeader, 0, 1) } mHs[m.Type] = append(mHs[m.Type], m) } wg := &sync.WaitGroup{} errorsChan := make(chan error, len(mHs)) for k, v := range mHs { wg.Add(1) go func(k MetricType, v []MetricHeader) { defer wg.Done() // Should be sorted and splitted by type & tenant.. on := o on = prepend(on, c.Url("POST", TypeEndpoint(k), DataEndpoint()), Data(v)) r, err := c.Send(on...) if err != nil { errorsChan <- err return } defer r.Body.Close() if r.StatusCode > 399 { errorsChan <- c.parseErrorResponse(r) } }(k, v) } wg.Wait() select { case err, ok := <-errorsChan: if ok { return err } // If channel is closed, we're done default: // Nothing to do } } return nil } // ReadMetric Read metric datapoints from the server func (c *Client) ReadMetric(t MetricType, id string, o ...Modifier) ([]*Datapoint, error) { o = prepend(o, c.Url("GET", TypeEndpoint(t), SingleMetricEndpoint(id), DataEndpoint())) r, err := c.Send(o...) if err != nil { return nil, err } defer r.Body.Close() if r.StatusCode == http.StatusOK { b, err := ioutil.ReadAll(r.Body) if err != nil { return nil, err } // Check for GaugeBucketpoint and so on for the rest.. uh dp := []*Datapoint{} if b != nil { if err = json.Unmarshal(b, &dp); err != nil { return nil, err } } return dp, nil } else if r.StatusCode > 399 { return nil, c.parseErrorResponse(r) } return nil, nil } // ReadBuckets Read datapoints from the server with in buckets (aggregates) func (c *Client) ReadBuckets(t MetricType, o ...Modifier) ([]*Bucketpoint, error) { o = prepend(o, c.Url("GET", TypeEndpoint(t), DataEndpoint())) r, err := c.Send(o...) if err != nil { return nil, err } defer r.Body.Close() if r.StatusCode == http.StatusOK { b, err := ioutil.ReadAll(r.Body) if err != nil { return nil, err } // Check for GaugeBucketpoint and so on for the rest.. uh bp := []*Bucketpoint{} if b != nil { if err = json.Unmarshal(b, &bp); err != nil { return nil, err } } return bp, nil } else if r.StatusCode > 399 { return nil, c.parseErrorResponse(r) } return nil, nil } // NewHawkularClient Initialization func NewHawkularClient(p Parameters) (*Client, error) { uri, err := url.Parse(p.Url) if err != nil { return nil, err } if uri.Path == "" { uri.Path = baseURL } u := &url.URL{ Host: uri.Host, Path: uri.Path, Scheme: uri.Scheme, Opaque: fmt.Sprintf("//%s/%s", uri.Host, uri.Path), } c := &http.Client{ Timeout: timeout, } if p.TLSConfig != nil { transport := &http.Transport{TLSClientConfig: p.TLSConfig} c.Transport = transport } if p.Concurrency < 1 { p.Concurrency = 1 } client := &Client{ url: u, Tenant: p.Tenant, Token: p.Token, client: c, pool: make(chan *poolRequest, p.Concurrency), } for i := 0; i < p.Concurrency; i++ { go client.sendRoutine() } return client, nil } // Close Safely close the Hawkular-Metrics client and flush remaining work func (c *Client) Close() { close(c.pool) } // HTTP Helper functions func (c *Client) parseErrorResponse(resp *http.Response) error { // Parse error messages here correctly.. reply, err := ioutil.ReadAll(resp.Body) if err != nil { return &HawkularClientError{Code: resp.StatusCode, msg: fmt.Sprintf("Reply could not be read: %s", err.Error()), } } details := &HawkularError{} err = json.Unmarshal(reply, details) if err != nil { return &HawkularClientError{Code: resp.StatusCode, msg: fmt.Sprintf("Reply could not be parsed: %s", err.Error()), } } return &HawkularClientError{Code: resp.StatusCode, msg: details.ErrorMsg, } } // Endpoint URL functions (...) func (c *Client) createURL(e ...Endpoint) *url.URL { mu := *c.url for _, f := range e { f(&mu) } return &mu } // TypeEndpoint URL endpoint setting metricType func TypeEndpoint(t MetricType) Endpoint { return func(u *url.URL) { addToURL(u, t.String()) } } // SingleMetricEndpoint URL endpoint for requesting single metricID func SingleMetricEndpoint(id string) Endpoint { return func(u *url.URL) { addToURL(u, url.QueryEscape(id)) } } // TagEndpoint URL endpoint to check tags information func TagEndpoint() Endpoint { return func(u *url.URL) { addToURL(u, "tags") } } // TagsEndpoint URL endpoint which adds tags query func TagsEndpoint(tags map[string]string) Endpoint { return func(u *url.URL) { addToURL(u, tagsEncoder(tags)) } } // DataEndpoint URL endpoint for inserting / requesting datapoints func DataEndpoint() Endpoint { return func(u *url.URL) { addToURL(u, "data") } } func addToURL(u *url.URL, s string) *url.URL { u.Opaque = fmt.Sprintf("%s/%s", u.Opaque, s) return u } func tagsEncoder(t map[string]string) string { tags := make([]string, 0, len(t)) for k, v := range t { tags = append(tags, fmt.Sprintf("%s:%s", k, v)) } j := strings.Join(tags, ",") return j } hawkular-client-go-0.6.0/metrics/client_test.go000066400000000000000000000166251267701110100215320ustar00rootroot00000000000000package metrics import ( "crypto/rand" "crypto/tls" "fmt" assert "github.com/stretchr/testify/require" "net/http" "net/http/httptest" "reflect" "testing" "time" ) func integrationClient() (*Client, error) { t, err := randomString() if err != nil { return nil, err } p := Parameters{Tenant: t, Url: "http://localhost:8080"} // p := Parameters{Tenant: t, Host: "localhost:8180"} // p := Parameters{Tenant: t, Url: "http://192.168.1.105:8080"} // p := Parameters{Tenant: t, Host: "209.132.178.218:18080"} return NewHawkularClient(p) } func randomString() (string, error) { b := make([]byte, 16) if _, err := rand.Read(b); err != nil { return "", err } return fmt.Sprintf("%X", b[:]), nil } func createError(err error) { } func TestTenantModifier(t *testing.T) { c, err := integrationClient() assert.Nil(t, err) ot, _ := randomString() // Create for another tenant id := "test.metric.create.numeric.tenant.1" md := MetricDefinition{Id: id, Type: Gauge} ok, err := c.Create(md, Tenant(ot)) assert.Nil(t, err) assert.True(t, ok, "MetricDefinition should have been created") // Try to fetch from default tenant - should fail mds, err := c.Definitions(Filters(TypeFilter(Gauge))) assert.Nil(t, err) assert.Nil(t, mds) // Try to fetch from the given tenant - should succeed mds, err = c.Definitions(Filters(TypeFilter(Gauge)), Tenant(ot)) assert.Nil(t, err) assert.Equal(t, 1, len(mds)) } func TestCreate(t *testing.T) { c, err := integrationClient() assert.Nil(t, err) id := "test.metric.create.numeric.1" md := MetricDefinition{Id: id, Type: Gauge} ok, err := c.Create(md) assert.Nil(t, err) assert.True(t, ok, "MetricDefinition should have been created") // Following would be nice: // mdd, err := c.Definitions(Filters(Type(Gauge), Id(id))) // mdd, err := c.Definition(Gauge, id) // assert.Nil(t, err) // assert.Equal(t, md.Id, mdd.Id) // Try to recreate the same.. ok, err = c.Create(md) assert.False(t, ok, "Should have received false when recreating them same metric") assert.Nil(t, err) // Use tags and dataRetention tags := make(map[string]string) tags["units"] = "bytes" tags["env"] = "unittest" md_tags := MetricDefinition{Id: "test.metric.create.numeric.2", Tags: tags, Type: Gauge} ok, err = c.Create(md_tags) assert.True(t, ok, "MetricDefinition should have been created") assert.Nil(t, err) md_reten := MetricDefinition{Id: "test/metric/create/availability/1", RetentionTime: 12, Type: Availability} ok, err = c.Create(md_reten) assert.Nil(t, err) assert.True(t, ok, "MetricDefinition should have been created") // Fetch all the previously created metrics and test equalities.. mdq, err := c.Definitions(Filters(TypeFilter(Gauge))) assert.Nil(t, err) assert.Equal(t, 2, len(mdq), "Size of the returned gauge metrics does not match 2") mdm := make(map[string]MetricDefinition) for _, v := range mdq { mdm[v.Id] = *v } assert.Equal(t, md.Id, mdm[id].Id) assert.True(t, reflect.DeepEqual(tags, mdm["test.metric.create.numeric.2"].Tags)) mda, err := c.Definitions(Filters(TypeFilter(Availability))) assert.Nil(t, err) assert.Equal(t, 1, len(mda)) assert.Equal(t, "test/metric/create/availability/1", mda[0].Id) assert.Equal(t, 12, mda[0].RetentionTime) if mda[0].Type != Availability { assert.FailNow(t, "Type did not match Availability", int(mda[0].Type)) } } func TestTagsModification(t *testing.T) { c, err := integrationClient() assert.Nil(t, err) id := "test/tags/modify/1" // Create metric without tags md := MetricDefinition{Id: id, Type: Gauge} ok, err := c.Create(md) assert.Nil(t, err) assert.True(t, ok, "MetricDefinition should have been created") // Add tags tags := make(map[string]string) tags["ab"] = "ac" tags["host"] = "test" err = c.UpdateTags(Gauge, id, tags) assert.Nil(t, err) // Fetch metric tags - check for equality md_tags, err := c.Tags(Gauge, id) assert.Nil(t, err) assert.True(t, reflect.DeepEqual(tags, md_tags), "Tags did not match the updated ones") // Delete some metric tags err = c.DeleteTags(Gauge, id, tags) assert.Nil(t, err) // Fetch metric - check that tags were deleted md_tags, err = c.Tags(Gauge, id) assert.Nil(t, err) assert.False(t, len(md_tags) > 0, "Received deleted tags") } func TestAddMixedMulti(t *testing.T) { // Modify to send both Availability as well as Gauge metrics at the same time c, err := integrationClient() assert.NoError(t, err) mone := Datapoint{Value: 1.45, Timestamp: UnixMilli(time.Now())} hone := MetricHeader{ Id: "test.multi.numeric.1", Data: []Datapoint{mone}, Type: Gauge, } mtwo_1 := Datapoint{Value: 2, Timestamp: UnixMilli(time.Now())} mtwo_2_t := UnixMilli(time.Now()) - 1e3 mtwo_2 := Datapoint{Value: float64(4.56), Timestamp: mtwo_2_t} htwo := MetricHeader{ Id: "test.multi.numeric.2", Data: []Datapoint{mtwo_1, mtwo_2}, Type: Counter, } h := []MetricHeader{hone, htwo} err = c.Write(h) assert.NoError(t, err) time.Sleep(1000 * time.Millisecond) var checkDatapoints = func(id string, typ MetricType, expected int) []*Datapoint { metric, err := c.ReadMetric(typ, id) assert.NoError(t, err) assert.Equal(t, expected, len(metric), "Amount of datapoints does not match expected value") return metric } checkDatapoints(hone.Id, hone.Type, 1) checkDatapoints(htwo.Id, htwo.Type, 2) } func TestCheckErrors(t *testing.T) { c, err := integrationClient() assert.Nil(t, err) mH := MetricHeader{ Id: "test.number.as.string", Data: []Datapoint{Datapoint{Value: "notFloat"}}, Type: Gauge, } err = c.Write([]MetricHeader{mH}) assert.NotNil(t, err, "Invalid non-float value should not be accepted") _, err = c.ReadMetric(mH.Type, mH.Id) assert.Nil(t, err, "Querying empty metric should not generate an error") } func TestTokenAuthenticationWithSSL(t *testing.T) { s := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { w.Header().Set("X-Authorization", r.Header.Get("Authorization")) })) defer s.Close() tenant, err := randomString() assert.NoError(t, err) tC := &tls.Config{InsecureSkipVerify: true} p := Parameters{ Tenant: tenant, Url: s.URL, Token: "62590bf9827213afadea8b5077a5bdc0", TLSConfig: tC, } c, err := NewHawkularClient(p) assert.NoError(t, err) r, err := c.Send(c.Url("GET")) assert.NoError(t, err) assert.Equal(t, fmt.Sprintf("Bearer %s", p.Token), r.Header.Get("X-Authorization")) } func TestBuckets(t *testing.T) { c, err := integrationClient() assert.NoError(t, err) tags := make(map[string]string) tags["units"] = "bytes" tags["env"] = "unittest" md_tags := MetricDefinition{Id: "test.buckets.1", Tags: tags, Type: Gauge} ok, err := c.Create(md_tags) assert.NoError(t, err) assert.True(t, ok) mone := Datapoint{Value: 1.45, Timestamp: UnixMilli(time.Now())} hone := MetricHeader{ Id: "test.buckets.1", Data: []Datapoint{mone}, Type: Gauge, } err = c.Write([]MetricHeader{hone}) assert.NoError(t, err) // TODO Muuta PercentilesFilter -> Percentiles (modifier) bp, err := c.ReadBuckets(Gauge, Filters(TagsFilter(tags), BucketsFilter(1), PercentilesFilter([]float64{90.0, 99.0}))) assert.NoError(t, err) assert.NotNil(t, bp) assert.Equal(t, 1, len(bp)) assert.Equal(t, int64(1), bp[0].Samples) assert.Equal(t, 2, len(bp[0].Percentiles)) assert.Equal(t, 1.45, bp[0].Percentiles[0].Value) assert.Equal(t, 0.9, bp[0].Percentiles[0].Quantile) assert.True(t, bp[0].Percentiles[1].Quantile >= 0.99) // Double arithmetic could cause this to be 0.9900000001 etc } hawkular-client-go-0.6.0/metrics/helpers.go000066400000000000000000000037771267701110100206630ustar00rootroot00000000000000/* Copyright 2015-2016 Red Hat, Inc. and/or its affiliates and other contributors. 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 metrics import ( "fmt" "math" "strconv" "time" ) func (c *Client) sendRoutine() { for { select { case pr, open := <-c.pool: if !open { return } resp, err := c.client.Do(pr.req) pr.rChan <- &poolResponse{err, resp} } } } // ConvertToFloat64 Return float64 from most numeric types func ConvertToFloat64(v interface{}) (float64, error) { switch i := v.(type) { case float64: return float64(i), nil case float32: return float64(i), nil case int64: return float64(i), nil case int32: return float64(i), nil case int16: return float64(i), nil case int8: return float64(i), nil case uint64: return float64(i), nil case uint32: return float64(i), nil case uint16: return float64(i), nil case uint8: return float64(i), nil case int: return float64(i), nil case uint: return float64(i), nil case string: f, err := strconv.ParseFloat(i, 64) if err != nil { return math.NaN(), err } return f, err default: return math.NaN(), fmt.Errorf("Cannot convert %s to float64", i) } } // UnixMilli Returns milliseconds since epoch func UnixMilli(t time.Time) int64 { return t.UnixNano() / 1e6 } // Prepend Helper function to insert modifier in the beginning of slice func prepend(slice []Modifier, a ...Modifier) []Modifier { p := make([]Modifier, 0, len(slice)+len(a)) p = append(p, a...) p = append(p, slice...) return p } hawkular-client-go-0.6.0/metrics/types.go000066400000000000000000000115201267701110100203460ustar00rootroot00000000000000/* Copyright 2015-2016 Red Hat, Inc. and/or its affiliates and other contributors. 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 metrics import ( "crypto/tls" "encoding/json" "fmt" "net/http" "net/url" ) // HawkularClientError Extracted error information from Hawkular-Metrics server type HawkularClientError struct { msg string Code int } // Parameters Initialization parameters to the client type Parameters struct { Tenant string // Technically optional, but requires setting Tenant() option everytime Url string TLSConfig *tls.Config Token string Concurrency int } // Client HawkularClient's data structure type Client struct { Tenant string url *url.URL client *http.Client Token string pool chan (*poolRequest) } type poolRequest struct { req *http.Request rChan chan (*poolResponse) } type poolResponse struct { err error resp *http.Response } // HawkularClient HawkularClient base type to define available functions.. type HawkularClient interface { Send(*http.Request) (*http.Response, error) } // Modifier Modifiers base type type Modifier func(*http.Request) error // Filter Filter type for querying type Filter func(r *http.Request) // Endpoint Endpoint type to define request URL type Endpoint func(u *url.URL) // MetricType restrictions type MetricType int const ( Gauge = iota Availability Counter Generic ) var longForm = []string{ "gauges", "availability", "counters", "metrics", } var shortForm = []string{ "gauge", "availability", "counter", "metrics", } func (mt MetricType) validate() error { if int(mt) > len(longForm) && int(mt) > len(shortForm) { return fmt.Errorf("Given MetricType value %d is not valid", mt) } return nil } // String Get string representation of type func (mt MetricType) String() string { if err := mt.validate(); err != nil { return "unknown" } return longForm[mt] } func (mt MetricType) shortForm() string { if err := mt.validate(); err != nil { return "unknown" } return shortForm[mt] } // UnmarshalJSON Custom unmarshaller for MetricType func (mt *MetricType) UnmarshalJSON(b []byte) error { var f interface{} err := json.Unmarshal(b, &f) if err != nil { return err } if str, ok := f.(string); ok { for i, v := range shortForm { if str == v { *mt = MetricType(i) break } } } return nil } // MarshalJSON Custom marshaller for MetricType func (mt MetricType) MarshalJSON() ([]byte, error) { return json.Marshal(mt.String()) } // Hawkular-Metrics external structs // Do I need external.. hmph. type MetricHeader struct { Tenant string `json:"-"` Type MetricType `json:"-"` Id string `json:"id"` Data []Datapoint `json:"data"` } // Datapoint Value should be convertible to float64 for numeric values, Timestamp is milliseconds since epoch type Datapoint struct { Timestamp int64 `json:"timestamp"` Value interface{} `json:"value"` Tags map[string]string `json:"tags,omitempty"` } // HawkularError Return payload from Hawkular-Metrics if processing failed type HawkularError struct { ErrorMsg string `json:"errorMsg"` } type MetricDefinition struct { Tenant string `json:"-"` Type MetricType `json:"type,omitempty"` Id string `json:"id"` Tags map[string]string `json:"tags,omitempty"` RetentionTime int `json:"dataRetention,omitempty"` } // TODO Fix the Start & End to return a time.Time // Bucketpoint Return structure for bucketed data type Bucketpoint struct { Start int64 `json:"start"` End int64 `json:"end"` Min float64 `json:"min"` Max float64 `json:"max"` Avg float64 `json:"avg"` Median float64 `json:"median"` Empty bool `json:"empty"` Samples int64 `json:"samples"` Percentiles []Percentile `json:"percentiles"` } // Percentile Hawkular-Metrics calculated percentiles representation type Percentile struct { Quantile float64 `json:"quantile"` Value float64 `json:"value"` } // Order Basetype for selecting the sorting of datapoints type Order int const ( // ASC Ascending ASC = iota // DESC Descending DESC ) // String Get string representation of type func (o Order) String() string { switch o { case ASC: return "ASC" case DESC: return "DESC" } return "" }