kvrhdn / go-honeycombio Goto Github PK

Expand QuerySpec with the fields orders and limit, as described by the docs.

This is required for honeycombio/terraform-provider-honeycombio#19 and honeycombio/terraform-provider-honeycombio#20.

Not all requests are linked to a dataset, for instance when creating a board you can add queries that refer to multiple datasets. As such, it does not make sense to store a global dataset in Client.
We should change the APIs of marker and trigger to take a dataset parameter.

It'd be great to see SLO support in this client library.

Add contributing.md to help out people that want to contribute.

Things we should discuss:

• How to run the tests (i.e. setting the environment variables)
• How to setup GitHub Actions in the fork
• Maybe something about code style? I.e. running go fmt etc.
• ...

Originally reported in honeycombio/terraform-provider-honeycombio#53

Responses from the Triggers and Boards API have changed:

GET triggers:

{
  "name": "Test trigger created at 2021-02-19 12:57:13.409454 +0100 CET m=+9.912250887",
  "description": "Some description",
  "frequency": 300,
  "disabled": true,
  "query_id": "E2fFNGt1wMo",
  "threshold": {
    "op": ">",
    "value": 10000
  },
  "recipients": [
    {
      "type": "email",
      "target": "[email protected]",
      "id": "ADFR34ZJJg3"
    }
  ],
  "id": "BkycQ1sif9h"
}

The field query_id is new and not documented. This used to be a field query containing a Query Specification.
Docs: https://docs.honeycomb.io/api/triggers/

GET boards:

{
  "name": "Test Board, created at 2021-02-19 12:57:03.501775 +0100 CET m=+0.004643366",
  "description": "A board with some queries",
  "style": "visual",
  "queries": [
    {
      "caption": "A sample query",
      "dataset": "kvrhdn/go-honeycombio",
      "query_id": "wZoqhtwRgLq",
      "query_annotation_id": "",
      "query_style": "combo"
    }
  ],
  "id": "Fptm5iangBw"
}

The fields query_id and query_annotation_id are new and not documented. This used to be a field query containing a Query Specification.
Docs: https://docs.honeycomb.io/api/boards/