ClusterCockpit/cc-metric-collector
1
0
Fork 0
mirror of https://github.com/ClusterCockpit/cc-metric-collector.git synced 2025-04-19 03:05:55 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update README for CCMetric

Browse Source
This commit is contained in:
Thomas Roehl 2021-12-21 14:04:14 +01:00
parent 3c5b5f4d71
commit 988cea381e
1 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
internal/ccMetric/README.md
View File

@ -7,12 +7,26 @@ It is basically a copy of the [InfluxDB line protocol](https://github.com/influx
``` ```
type ccMetric struct { type ccMetric struct {
name string // same as name string // same as
tags []*influx.Tag // original tags []*influx.Tag // original
fields []*influx.Field // Influx fields []*influx.Field // Influx
tm time.Time // line-protocol tm time.Time // line-protocol
meta []*influx.Tag meta []*influx.Tag
}
type CCMetric interface {
influx.MutableMetric // the same functions as defined by influx.MutableMetric
RemoveTag(key string) // this is not published by the original influx.MutableMetric
Meta() map[string]string
MetaList() []*lp.Tag
AddMeta(key, value string)
HasMeta(key string) bool
GetMeta(key string) (string, bool)
RemoveMeta(key string)
} }
``` ```
The `CCMetric` interface provides the same functions as the `MutableMetric` like `{Add, Remove, Has}{Tag, Field}` and additionally provides `{Add, Remove, Has}Meta` The `CCMetric` interface provides the same functions as the `MutableMetric` like `{Add, Remove, Has}{Tag, Field}` and additionally provides `{Add, Remove, Has}Meta`.
The InfluxDB protocol creates a new metric with `influx.New(name, tags, fields, time)` while CCMetric uses `ccMetric.New(name, tags, meta, fields, time)` where `tags` and `meta` are both of type `map[string]string`.
You can copy a CCMetric with `FromMetric(other CCMetric) CCMetric`. If you get an `influx.Metric` from a function, like the line protocol parser, you can use `FromInfluxMetric(other influx.Metric) CCMetric` to get a CCMetric out of it (see `NatsReceiver` for an example).