Skip to content

Commit

Permalink
Add support for app_state metricset (elastic#20639)
Browse files Browse the repository at this point in the history
* mofidy doc

* add metricset

* chnagelog

* config

* work on app_state

* remove extra

* fix changelog

* mage fmt update

* work on mapping fields

* work on tests

* fix vis name

* no default

* fix tests

* add headers
  • Loading branch information
narph authored Oct 5, 2020
1 parent 3d8e7dd commit 67a2d38
Show file tree
Hide file tree
Showing 31 changed files with 2,275 additions and 86 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.next.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
- Add missing info about the rest of the azure metricsets in the documentation. {pull}19601[19601]
- Fix k8s scheduler compatibility issue. {pull}19699[19699]
- Fix SQL module mapping NULL values as string {pull}18955[18955] {issue}18898[18898
- Add support for azure light metricset app_stats. {pull}20639[20639]
- Fix ec2 disk and network metrics to use Sum statistic method. {pull}20680[20680]
- Fill cloud.account.name with accountID if account alias doesn't exist. {pull}20736[20736]
- The Kibana collector applies backoff when errored at getting usage stats {pull}20772[20772]
Expand Down
223 changes: 215 additions & 8 deletions metricbeat/docs/fields.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4665,6 +4665,16 @@ type: keyword
The subscription ID


type: keyword

--

*`azure.application_id`*::
+
--
The application ID


type: keyword

--
Expand Down Expand Up @@ -4696,17 +4706,44 @@ application insights



*`azure.app_insights.application_id`*::
*`azure.app_insights.start_date`*::
+
--
The application ID
The start date


type: keyword
type: date

--

*`azure.app_insights.start_date`*::
*`azure.app_insights.end_date`*::
+
--
The end date


type: date

--

*`azure.app_insights.metrics.*.*`*::
+
--
The metrics


type: object

--

[float]
=== app_state

application state



*`azure.app_state.start_date`*::
+
--
The start date
Expand All @@ -4716,7 +4753,7 @@ type: date

--

*`azure.app_insights.end_date`*::
*`azure.app_state.end_date`*::
+
--
The end date
Expand All @@ -4726,13 +4763,183 @@ type: date

--

*`azure.app_insights.metrics.*.*`*::
*`azure.app_state.requests_count.sum`*::
+
--
The metrics
Request count


type: object
type: float

--

*`azure.app_state.requests_failed.sum`*::
+
--
Request failed count


type: float

--

*`azure.app_state.users_count.unique`*::
+
--
User count


type: float

--

*`azure.app_state.sessions_count.unique`*::
+
--
Session count


type: float

--

*`azure.app_state.users_authenticated.unique`*::
+
--
Authenticated users count


type: float

--

*`azure.app_state.browser_timings_network_duration.avg`*::
+
--
Browser timings network duration


type: float

--

*`azure.app_state.browser_timings_send_duration.avg`*::
+
--
Browser timings send duration


type: float

--

*`azure.app_state.browser_timings_receive_uration.avg`*::
+
--
Browser timings receive duration


type: float

--

*`azure.app_state.browser_timings_processing_duration.avg`*::
+
--
Browser timings processing duration


type: float

--

*`azure.app_state.browser_timings_total_duration.avg`*::
+
--
Browser timings total duration


type: float

--

*`azure.app_state.exceptions_count.sum`*::
+
--
Exception count


type: float

--

*`azure.app_state.exceptions_browser.sum`*::
+
--
Exception count at browser level


type: float

--

*`azure.app_state.exceptions_server.sum`*::
+
--
Exception count at server level


type: float

--

*`azure.app_state.performance_counters_memory_available_bytes.avg`*::
+
--
Performance counters memory available bytes


type: float

--

*`azure.app_state.performance_counters_process_private_bytes.avg`*::
+
--
Performance counters process private bytes


type: float

--

*`azure.app_state.performance_counters_process_cpu_percentage_total.avg`*::
+
--
Performance counters process cpu percentage total


type: float

--

*`azure.app_state.performance_counters_process_cpu_percentage.avg`*::
+
--
Performance counters process cpu percentage


type: float

--

*`azure.app_state.performance_counters_processiobytes_per_second.avg`*::
+
--
Performance counters process IO bytes per second


type: float

--

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions metricbeat/docs/modules/azure.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ The Azure billing dashboards show relevant usage and forecast information:

image::./images/metricbeat-azure-billing-overview.png[]

The Azure app_state dashboard shows relevant application insights information:

image::./images/metricbeat-azure-app-state-overview.png[]

[float]
=== Module-specific configuration notes

Expand Down Expand Up @@ -120,6 +124,10 @@ so the `period` for `billing` metricset should be `24h` or multiples of `24h`.
=== `app_insights`
This metricset will collect application insights metrics, the `period` (interval) for the `app-insights` metricset is set by default at `300s`.

[float]
=== `app_state`
This metricset concentrate on the most relevant application insights metrics and provides a dashboard for visualization, the `period` (interval) for the `app_state` metricset is set by default at `300s`.

[float]
[[azure-api-cost]]
== Additional notes about metrics and costs
Expand Down Expand Up @@ -242,6 +250,14 @@ metricbeat.modules:
api_key: ''
metrics:
- id: ["requests/count", "requests/duration"]
- module: azure
metricsets:
- app_state
enabled: true
period: 300s
application_id: ''
api_key: ''
----

[float]
Expand All @@ -251,6 +267,8 @@ The following metricsets are available:

* <<metricbeat-metricset-azure-app_insights,app_insights>>

* <<metricbeat-metricset-azure-app_state,app_state>>

* <<metricbeat-metricset-azure-billing,billing>>

* <<metricbeat-metricset-azure-compute_vm,compute_vm>>
Expand All @@ -271,6 +289,8 @@ The following metricsets are available:

include::azure/app_insights.asciidoc[]

include::azure/app_state.asciidoc[]

include::azure/billing.asciidoc[]

include::azure/compute_vm.asciidoc[]
Expand Down
24 changes: 24 additions & 0 deletions metricbeat/docs/modules/azure/app_state.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
////
This file is generated! See scripts/mage/docs_collector.go
////

[[metricbeat-metricset-azure-app_state]]
[role="xpack"]
=== Azure app_state metricset

beta[]

include::../../../../x-pack/metricbeat/module/azure/app_state/_meta/docs.asciidoc[]


==== Fields

For a description of each field in the metricset, see the
<<exported-fields-azure,exported fields>> section.

Here is an example document generated by this metricset:

[source,json]
----
include::../../../../x-pack/metricbeat/module/azure/app_state/_meta/data.json[]
----
3 changes: 2 additions & 1 deletion metricbeat/docs/modules_list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ This file is generated! See scripts/mage/docs_collector.go
|<<metricbeat-metricset-aws-usage,usage>> beta[]
|<<metricbeat-metricset-aws-vpn,vpn>> beta[]
|<<metricbeat-module-azure,Azure>> |image:./images/icon-yes.png[Prebuilt dashboards are available] |
.10+| .10+| |<<metricbeat-metricset-azure-app_insights,app_insights>> beta[]
.11+| .11+| |<<metricbeat-metricset-azure-app_insights,app_insights>> beta[]
|<<metricbeat-metricset-azure-app_state,app_state>> beta[]
|<<metricbeat-metricset-azure-billing,billing>> beta[]
|<<metricbeat-metricset-azure-compute_vm,compute_vm>>
|<<metricbeat-metricset-azure-compute_vm_scaleset,compute_vm_scaleset>>
Expand Down
8 changes: 8 additions & 0 deletions x-pack/metricbeat/metricbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,14 @@ metricbeat.modules:
metrics:
- id: ["requests/count", "requests/duration"]

- module: azure
metricsets:
- app_state
enabled: true
period: 300s
application_id: ''
api_key: ''

#--------------------------------- Beat Module ---------------------------------
- module: beat
metricsets:
Expand Down
8 changes: 8 additions & 0 deletions x-pack/metricbeat/module/azure/_meta/config.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,11 @@
api_key: ''
metrics:
- id: ["requests/count", "requests/duration"]

- module: azure
metricsets:
- app_state
enabled: true
period: 300s
application_id: ''
api_key: ''
8 changes: 8 additions & 0 deletions x-pack/metricbeat/module/azure/_meta/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -111,3 +111,11 @@
# api_key: ''
# metrics:
# - id: ["requests/count", "requests/duration"]

#- module: azure
# metricsets:
# - app_state
# enabled: true
# period: 300s
# application_id: ''
# api_key: ''
Loading

0 comments on commit 67a2d38

Please sign in to comment.