\r\n\r\nThis library is made for [inspector-metrics](https://github.com/rstiller/inspector-metrics) node module and\r\nis meant to be used with `typescript` / `nodejs`. \r\nIt uses [elasticsearch-js](https://github.com/elastic/elasticsearch-js) as elasticsearch client.\r\n\r\n## install\r\n\r\n`npm install --save inspector-elasticsearch`\r\n\r\n## basic usage\r\n\r\n```typescript\r\nimport { MetricRegistry } from \"inspector-metrics\";\r\nimport { ElasticsearchMetricReporter } from \"inspector-elasticsearch\";\r\nimport { ConfigOptions } from \"elasticsearch\";\r\n\r\nconst clientOptions: ConfigOptions = {\r\n apiVersion: \"6.0\",\r\n host: \"localhost:9200\",\r\n};\r\n// instance the elasticsearch reporter\r\nconst reporter: ElasticsearchMetricReporter = new ElasticsearchMetricReporter({\r\n clientOptions,\r\n});\r\nconst registry: MetricRegistry = new MetricRegistry();\r\n\r\n// add the registry to the reporter\r\nreporter.addMetricRegistry(registry);\r\n// start reporting\r\nreporter.start();\r\n```\r\n\r\n### determine the indexname for a metric\r\n\r\n```typescript\r\nimport { MetricRegistry } from \"inspector-metrics\";\r\nimport {\r\n ElasticsearchMetricReporter,\r\n MetricInfoDeterminator\r\n} from \"inspector-elasticsearch\";\r\nimport { ConfigOptions } from \"elasticsearch\";\r\n\r\nconst clientOptions: ConfigOptions = { ... };\r\n// computes the name of the index using the timestamp of the metric\r\nconst indexnameDeterminator: MetricInfoDeterminator = (\r\n registry: MetricRegistry,\r\n metric: Metric,\r\n type: MetricType,\r\n date: Date) => {\r\n \r\n const day = date.getDate();\r\n const dayPrefix: string = (day >= 10) ? \"\" : \"0\";\r\n const month = date.getMonth() + 1;\r\n const monthPrefix: string = (month >= 10) ? \"\" : \"0\";\r\n return `metrics-${date.getFullYear()}-${monthPrefix}${month}-${dayPrefix}${day}`;\r\n};\r\n// the indexname generator needs to be specified when instancing the reporter\r\nconst reporter: ElasticsearchMetricReporter = new ElasticsearchMetricReporter({\r\n clientOptions,\r\n indexnameDeterminator, \r\n}\r\n);\r\n```\r\n\r\n### build a metric document\r\n\r\n```typescript\r\nimport { MetricRegistry } from \"inspector-metrics\";\r\nimport {\r\n ElasticsearchMetricReporter,\r\n MetricDocumentBuilder,\r\n MetricType\r\n} from \"inspector-elasticsearch\";\r\nimport { ConfigOptions } from \"elasticsearch\";\r\n\r\nconst clientOptions: ConfigOptions = { ... };\r\n// only build documents for counter metrics\r\nconst metricDocumentBuilder: MetricDocumentBuilder = (\r\n registry: MetricRegistry,\r\n metric: Metric,\r\n type: MetricType,\r\n timestamp: Date,\r\n commonTags: Map) => {\r\n\r\n if (metric instanceof Counter) {\r\n const tags = ElasticsearchMetricReporter.buildTags(commonTags, metric);\r\n const name = metric.getName();\r\n const group = metric.getGroup();\r\n return { name, group, tags, timestamp, values: { 'count': metric.getCount() }, type };\r\n\r\n } else {\r\n // null values will not be reported / published\r\n return null;\r\n }\r\n};\r\n\r\n// the document builder needs to be specified when instancing the reporter\r\nconst reporter: ElasticsearchMetricReporter = new ElasticsearchMetricReporter({\r\n clientOptions,\r\n metricDocumentBuilder,\r\n});\r\n```\r\n\r\n## dev\r\n\r\n### using the playground\r\n\r\nTo use the playground you need to have `docker` and `docker-compose` installed.\r\n\r\n```bash\r\nnpm run compile\r\n# running playground script\r\n./playground.sh\r\n```\r\n\r\n### view data in grafana\r\n\r\n1. Navigate to `http://localhost:3000`\r\n1. Add a new Data Source (type: elasticsearch, host / url: http://elasticsearch:9200)\r\n1. Create a new graph\r\n\r\n\r\n\r\n### view data in kibana\r\n\r\n1. Navigate to `http://localhost:5601`\r\n1. Add a new index pattern like `metric-*`\r\n1. Discover data\r\n\r\n\r\n\r\n## local dev\r\n\r\n### compile & test with different nodejs versions\r\n\r\nbuild docker images: \r\n```bash\r\ndocker-compose build\r\n```\r\n\r\nrun tests: \r\n```bash\r\ndocker-compose run node6\r\ndocker-compose run node7\r\ndocker-compose run node8\r\ndocker-compose run node9\r\ndocker-compose run node10\r\n```\r\n\r\n## License\r\n\r\n[MIT](https://www.opensource.org/licenses/mit-license.php)\r\n","readmeFilename":"README.md"}
![\"NPM](\"https://img.shields.io/npm/v/inspector-elasticsearch.svg\")
\r\n \r\n \r\n ![\"License\"](\"https://img.shields.io/npm/l/inspector-elasticsearch.svg\")
\r\n \r\n \r\n ![\"Build](\"http://img.shields.io/travis/rstiller/inspector-elasticsearch/master.svg\")
\r\n \r\n \r\n ![\"Dependencies](\"https://img.shields.io/david/rstiller/inspector-elasticsearch.svg\")
\r\n \r\n