Document Charts API for tags about api-docs HOT 11 CLOSED

A stream submitted with the tags property omitted or sent as an empty array ([]) should be equivalent to previous all behavior. For example:

{
  "type": "line",
  "name": "ELB Test",
  "streams": [
    {
      "metric": "AWS.ELB.Latency",
      "tags": [{"name": "region", "values": ["us-east-1"]}]
    },
    {
      "metric": "AWS.ELB.Latency"
    }
  ]
}

...should result in two streams. The second one should be an unfiltered summary line of all AWS.ELB.Latency streams.

We need to make sure that we demonstrate how grouping, summary func, group func, etc works as well in our examples. This may already be somewhere else but just want to make sure we aren't missing it.

FWIW we may currently require the tags_filter property in current API operations. I just want to be clear that we shouldn't expose that in our documentation and we will need to clean that up if so before GA.

from api-docs.

I don't think we want to expose the tags_filter field publicly as basically all streams are tags_filter: 'custom' now. Can you confirm @luk3thomas ?

from api-docs.

Agree...want to get this figured out since essentially the behavior is now binary.

from api-docs.

you can't do tags_filter: 'any' or all?

from api-docs.

You can definitely do all, e.g.:

{
  "type": "line",
  "name": "ELB Test",
  "streams": [
    {
      "metric": "aws.elb.latency",
      "tags_filter": "all"
    }
  ]
}

from api-docs.

so then we need to expose that or no? @jderrett @nextmat

from api-docs.

tags_filter is going away as a property, so we shouldn't expose it.

from api-docs.

@jderrett then we would need an example on how to not have a tag filter on a stream without using the tags_filter property. Might be as simple as not including it?

from api-docs.

@nextmat @luk3thomas submitting

{
  "type": "line",
  "name": "ELB Test",
  "streams": [
    {
      "metric": "AWS.ELB.Latency",
      "tags": [{"name": "region", "values": ["us-east-1"]}]
    },
    {
      "metric": "AWS.ELB.Latency"
    }
  ]
}

currently returns

{
  "errors": {
    "params": {
      "tags": [
        "is present"
      ]
    }
  }
}

I'm super glad to know tags is present \o/
If I add in "tags_filter": "custom" it starts working, so I assume we'll need some API fixes.

from api-docs.

Haha, yes, we need to fix that. We need to completely remove all tags_filter validations from the API. I'm tracking everything else we need to update here https://app.asana.com/0/227081860622057/228938011398920

from api-docs.

@jderrett removed the tags is present validation in https://github.com/librato/api/pull/1540. LMK if you see any other issues creating streams

from api-docs.