diff --git a/CHANGELOG.next.asciidoc b/CHANGELOG.next.asciidoc index 705e5aeebfdb..e9e3391a64b2 100644 --- a/CHANGELOG.next.asciidoc +++ b/CHANGELOG.next.asciidoc @@ -106,6 +106,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d - Add mesh metricset for Istio Metricbeat module {pull}15535[15535] - Add mixer metricset for Istio Metricbeat module {pull}15696[15696] - Make the `system/cpu` metricset collect normalized CPU metrics by default. {issue}15618[15618] {pull}15729[15729] +- Add STAN dashboard {pull}15654[15654] - Add support for Unix socket in Memcached metricbeat module. {issue}13685[13685] {pull}15822[15822] *Packetbeat* diff --git a/metricbeat/docs/images/metricbeat-stan-overview.png b/metricbeat/docs/images/metricbeat-stan-overview.png new file mode 100644 index 000000000000..a6ed419fe885 Binary files /dev/null and b/metricbeat/docs/images/metricbeat-stan-overview.png differ diff --git a/metricbeat/docs/modules/stan.asciidoc b/metricbeat/docs/modules/stan.asciidoc index 3efe11c72e0b..1d5698825702 100644 --- a/metricbeat/docs/modules/stan.asciidoc +++ b/metricbeat/docs/modules/stan.asciidoc @@ -17,6 +17,12 @@ The default metricsets are `channels`, `stats` and `subscriptions`. The STAN module is tested with STAN 0.15.1. +[float] +== Dashboard +Dashboards for topic message count and queue depth are included: + +image::./images/metricbeat-stan-overview.png[] + [float] === Example configuration diff --git a/metricbeat/docs/modules_list.asciidoc b/metricbeat/docs/modules_list.asciidoc index 02a4fa63a3bd..966644c48fbe 100644 --- a/metricbeat/docs/modules_list.asciidoc +++ b/metricbeat/docs/modules_list.asciidoc @@ -190,7 +190,7 @@ This file is generated! See scripts/mage/docs_collector.go |<> |<> beta[] |image:./images/icon-no.png[No prebuilt dashboards] | .1+| .1+| |<> beta[] -|<> beta[] |image:./images/icon-no.png[No prebuilt dashboards] | +|<> beta[] |image:./images/icon-yes.png[Prebuilt dashboards are available] | .3+| .3+| |<> beta[] |<> beta[] |<> beta[] diff --git a/x-pack/metricbeat/module/stan/_meta/docs.asciidoc b/x-pack/metricbeat/module/stan/_meta/docs.asciidoc index 7d78f5672b15..e50e7bb6ec0d 100644 --- a/x-pack/metricbeat/module/stan/_meta/docs.asciidoc +++ b/x-pack/metricbeat/module/stan/_meta/docs.asciidoc @@ -6,3 +6,9 @@ The default metricsets are `channels`, `stats` and `subscriptions`. === Compatibility The STAN module is tested with STAN 0.15.1. + +[float] +== Dashboard +Dashboards for topic message count and queue depth are included: + +image::./images/metricbeat-stan-overview.png[] diff --git a/x-pack/metricbeat/module/stan/_meta/kibana/7/dashboard/Metricbeat-STAN-overview.json b/x-pack/metricbeat/module/stan/_meta/kibana/7/dashboard/Metricbeat-STAN-overview.json new file mode 100644 index 000000000000..600c3d895ada --- /dev/null +++ b/x-pack/metricbeat/module/stan/_meta/kibana/7/dashboard/Metricbeat-STAN-overview.json @@ -0,0 +1,261 @@ +{ + "objects": [ + { + "attributes": { + "description": "Metrics for STAN channels / subjects", + "hits": 0, + "kibanaSavedObjectMeta": { + "searchSourceJSON": { + "filter": [], + "query": { + "language": "kuery", + "query": "STAN Metricbeats" + } + } + }, + "optionsJSON": { + "hidePanelTitles": false, + "useMargins": true + }, + "panelsJSON": [ + { + "embeddableConfig": {}, + "gridData": { + "h": 15, + "i": "e7171c3e-936d-4549-b913-1a8651ef55b8", + "w": 24, + "x": 0, + "y": 0 + }, + "panelIndex": "e7171c3e-936d-4549-b913-1a8651ef55b8", + "panelRefName": "panel_0", + "version": "7.5.1" + }, + { + "embeddableConfig": {}, + "gridData": { + "h": 15, + "i": "370515c5-80da-4288-aec4-7dca8107ef8e", + "w": 24, + "x": 24, + "y": 0 + }, + "panelIndex": "370515c5-80da-4288-aec4-7dca8107ef8e", + "panelRefName": "panel_1", + "version": "7.5.1" + } + ], + "timeRestore": false, + "title": "[Metricbeat Stan] Channel Overview Metrics", + "version": 1 + }, + "id": "dbf2e220-37ce-11ea-a9c8-152a657da3ab", + "migrationVersion": { + "dashboard": "7.3.0" + }, + "references": [ + { + "id": "fbc095e0-37cc-11ea-a9c8-152a657da3ab", + "name": "panel_0", + "type": "visualization" + }, + { + "id": "9385f9a0-33f0-11ea-a9c8-152a657da3ab", + "name": "panel_1", + "type": "visualization" + } + ], + "type": "dashboard", + "updated_at": "2020-01-15T19:40:18.114Z", + "version": "WzQ5LDFd" + }, + { + "attributes": { + "description": "Total number of messages in each channel / subject", + "kibanaSavedObjectMeta": { + "searchSourceJSON": { + "filter": [], + "query": { + "language": "kuery", + "query": "" + } + } + }, + "title": "Channel Messages [Metricbeat Stan]", + "uiStateJSON": {}, + "version": 1, + "visState": { + "aggs": [], + "params": { + "annotations": [ + { + "color": "#F00", + "fields": "", + "icon": "fa-tag", + "id": "f876b980-37b5-11ea-a566-c550422d89d4", + "ignore_global_filters": 1, + "ignore_panel_filters": 1, + "index_pattern": "metricbeat-*", + "query_string": { + "language": "kuery", + "query": "" + }, + "template": "", + "time_field": "@timestamp" + } + ], + "axis_formatter": "number", + "axis_position": "left", + "axis_scale": "normal", + "default_index_pattern": "metricbeat-*", + "default_timefield": "@timestamp", + "id": "61ca57f0-469d-11e7-af02-69e470af7417", + "index_pattern": "", + "interval": "", + "isModelInvalid": false, + "series": [ + { + "axis_position": "right", + "chart_type": "bar", + "color": "#68BC00", + "fill": 0.5, + "formatter": "number", + "id": "61ca57f1-469d-11e7-af02-69e470af7417", + "label": "STAN Queue Messages", + "line_width": 1, + "metrics": [ + { + "field": "stan.channels.messages", + "id": "61ca57f2-469d-11e7-af02-69e470af7417", + "type": "sum" + } + ], + "point_size": 1, + "separate_axis": 0, + "split_color_mode": "gradient", + "split_mode": "terms", + "stacked": "none", + "terms_field": "stan.channels.name.keyword", + "type": "timeseries" + } + ], + "show_grid": 1, + "show_legend": 1, + "time_field": "", + "type": "timeseries" + }, + "title": "Channel Messages [Metricbeat Stan]", + "type": "metrics" + } + }, + "id": "fbc095e0-37cc-11ea-a9c8-152a657da3ab", + "migrationVersion": { + "visualization": "7.3.1" + }, + "references": [], + "type": "visualization", + "updated_at": "2020-01-15T19:34:50.914Z", + "version": "WzQ2LDFd" + }, + { + "attributes": { + "description": "Queue depth of STAN channels, summed per channel", + "kibanaSavedObjectMeta": { + "searchSourceJSON": { + "filter": [], + "query": { + "language": "kuery", + "query": "" + } + } + }, + "title": "Channel Queue Depth [Metricbeat Stan]", + "uiStateJSON": {}, + "version": 1, + "visState": { + "aggs": [], + "params": { + "axis_formatter": "number", + "axis_position": "left", + "axis_scale": "normal", + "background_color_rules": [ + { + "id": "1cfde3b0-33f0-11ea-a5a9-419b0c5b7a83" + } + ], + "bar_color_rules": [ + { + "id": "1e324500-33f0-11ea-a5a9-419b0c5b7a83", + "operator": "gt", + "value": 10 + } + ], + "default_index_pattern": "metricbeat-*", + "default_timefield": "@timestamp", + "drilldown_url": "", + "filter": { + "language": "kuery", + "query": "" + }, + "gauge_color_rules": [ + { + "id": "9caf12a0-3634-11ea-a566-c550422d89d4" + } + ], + "gauge_inner_width": 10, + "gauge_style": "half", + "gauge_width": 10, + "id": "61ca57f0-469d-11e7-af02-69e470af7417", + "index_pattern": "", + "interval": "", + "isModelInvalid": false, + "series": [ + { + "axis_position": "right", + "chart_type": "bar", + "color": "#68BC00", + "fill": 0.5, + "filter": { + "language": "kuery", + "query": "" + }, + "formatter": "number", + "id": "61ca57f1-469d-11e7-af02-69e470af7417", + "label": "Queue Depth", + "line_width": 1, + "metrics": [ + { + "field": "stan.channels.depth", + "id": "61ca57f2-469d-11e7-af02-69e470af7417", + "type": "sum" + } + ], + "point_size": 1, + "separate_axis": 0, + "split_mode": "terms", + "stacked": "none", + "terms_field": "stan.channels.name.keyword", + "type": "timeseries" + } + ], + "show_grid": 1, + "show_legend": 1, + "time_field": "", + "type": "timeseries" + }, + "title": "Channel Queue Depth [Metricbeat Stan]", + "type": "metrics" + } + }, + "id": "9385f9a0-33f0-11ea-a9c8-152a657da3ab", + "migrationVersion": { + "visualization": "7.3.1" + }, + "references": [], + "type": "visualization", + "updated_at": "2020-01-15T19:34:29.870Z", + "version": "WzQ1LDFd" + } + ], + "version": "7.5.1" +} diff --git a/x-pack/metricbeat/module/stan/module.yml b/x-pack/metricbeat/module/stan/module.yml index 4a73fd825280..a297032b0f55 100644 --- a/x-pack/metricbeat/module/stan/module.yml +++ b/x-pack/metricbeat/module/stan/module.yml @@ -1,3 +1,3 @@ dashboards: - id: Metricbeat-STAN-Dashboard - file: Metricbeat-stan-overview.json + file: Metricbeat-STAN-overview.json