Splunk® Metrics Workspace

Using the Splunk Metrics Workspace

Download manual as PDF

This documentation does not apply to the most recent version of SMW. Click here for the latest version.
Download topic as PDF

Share data in the Splunk Metrics Workspace

When the Splunk Metrics Workspace is deployed on Splunk Enterprise, the Splunk platform sends anonymized usage data to Splunk Inc. ("Splunk") to help improve the Splunk Metrics Workspace in future releases. For information about how to opt in or out, and how the data is collected, stored, and governed, see Share data in Splunk Enterprise.

What data is collected

Component/Action Description Example
app.session.metrics.interact/
ADD_SOURCE_TO_VIEW
Tracks when an additional series is added to a chart.
{
action: ADD_SOURCE_TO_VIEW 
app: search 
context: analysis 
customInfo: {
app: metrics-analysis 
commitHash: f6dd0f5fd25c9db2b79bad5557ba703b194351b8 
version: 2.1.0 
} 
page: analysis_workspace 
type: view/UPDATE_SERIES 
viewId: vce3c6ff4-c214-4a3c-80dc-e4813cf8b883 
} 
app.session.metrics.interact/
analysis-create-alert
Measures contents of alert creation payload.
{
"action": "analysis-create-alert",
"frequency": {
"frequency": "12",
"unit": "h"
},
"isEdit": false,
"lookback": "12m",
"throttle": {
"enabled": true,
"period": "32s"
},
"context": "alerting",
"customInfo": {
"app": "metrics-analysis",
"commitHash": "dfaff67acb4b2cce2cdb0824732ed31bec050f04",
"version": "0.20.0"
},
"app": "search",
"page": "analysis_workspace"
}
app.session.metrics.interact/
app/SET_TIME_RANGE
Measures time range changes.
{
"customInfo": {
"app": "metrics-analysis",
"version": "0.20.0",
"commitHash": "2e093684ad2ada74b7cd8b5b5cf22d83e5ae8888"
},
"page": "analysis_workspace",
"app": "search",
"action": "app/SET_TIME_RANGE",
"context": "analysis",
"preset": "-30m"
}
app.session.metrics.interact/
app/SET_TIME_ZOOM
Reports changes to the time zoom.
{
"latest": 1527267421387,
"page": "analysis_workspace",
"app": "search",
"earliest": 1527266024912,
"action": "app/SET_TIME_ZOOM",
"customInfo": {
"app": "metrics-analysis",
"version": "0.20.0",
"commitHash": "dfaff67acb4b2cce2cdb0824732ed31bec050f04"
},
"context": "analysis",
"elapsed": 1396475
}
app.session.metrics.interact/
instrumentation/TRACK_ACTION
Measures chart actions, including saving a chart as a report and cloning a chart. To save a chart as a report:
{
accessor: METRICS 
action: instrumentation/TRACK_ACTION 
app: search 
content: chart 
context: analysis 
customInfo: {
app: metrics-analysis 
commitHash: 5a090708d948d6a821aff570a8862368d00e67f3 
version: 1.13.0 
} 
page: analysis_workspace 
timeRange: {
earliest: -3h 
} 
timeRangePicker: 0 
type: export_chart_to_report 
} 

To clone a chart:

{
action: instrumentation/TRACK_ACTION 
app: search 
context: analysis 
customInfo: {
app: metrics-analysis 
commitHash: f6dd0f5fd25c9db2b79bad5557ba703b194351b8 
version: 2.1.0 
} 
page: analysis_workspace 
type: CLONE_PANEL 
} 
app.session.metrics.interact/
REMOVE_MEASURE
Measures chart removal.
{
"action": "REMOVE_MEASURE",
"context": "analysis",
"customInfo": {
"app": "metrics-analysis",
"commitHash": "dfaff67acb4b2cce2cdb0824732ed31bec050f04",
"version": "0.20.0"
},
"app": "search",
"page": "analysis_workspace"
}
app.session.metrics.interact/
SERIES_CLONE
Measures cloning a series on a chart.
{
accessor: METRICS 
action: SERIES_CLONE 
app: search 
context: analysis 
customInfo: {
app: metrics-analysis 
commitHash: f6dd0f5fd25c9db2b79bad5557ba703b194351b8 
version: 2.0.0 
} 
numFilters: 0 
numMeasures: 1 
numSeries: 4 
page: analysis_workspace 
seriesHasSplit: false 
seriesId: 5b2c9d78-b1ac-4878-b432-a8596368a3f8 
type: view/UPDATE_SERIES 
value: 5b2c9d78-b1ac-4878-b432-a8596368a3f8 
viewId: vbc755db2-4120-4af6-9b83-75fd950217b3 
} 
app.session.metrics.interact/
SERIES_FILTER_ADD
Tracks adding a dimension filter to a series on a chart.
{
accessor: METRICS 
action: SERIES_FILTER_ADD 
app: search 
context: analysis 
customInfo: {
app: metrics-analysis 
commitHash: f6dd0f5fd25c9db2b79bad5557ba703b194351b8 
version: 2.0.0 
} 
numFilters: 1 
numMeasures: 1 
numSeries: 3 
page: analysis_workspace 
seriesHasSplit: true 
seriesId: ed08e1e2-5a89-48b6-9789-066e83f6a918 
type: view/UPDATE_SERIES 
value: {
memberCount: 2 
type: include 
wildcardCount: 0 
} 
viewId: vbc755db2-4120-4af6-9b83-75fd950217b3 
} 
app.session.metrics.interact/
SERIES_FILTER_DELETE
Tracks the removal of a dimension filter from a series through the Filters panel.
{
accessor: METRICS 
action: SERIES_FILTER_DELETE 
app: search 
context: analysis 
customInfo: {
app: metrics-analysis 
commitHash: f6dd0f5fd25c9db2b79bad5557ba703b194351b8 
version: 2.0.0 
} 
numFilters: 0 
numMeasures: 1 
numSeries: 3 
page: analysis_workspace 
seriesHasSplit: true 
seriesId: ed08e1e2-5a89-48b6-9789-066e83f6a918 
type: view/UPDATE_SERIES 
value: null 
viewId: vbc755db2-4120-4af6-9b83-75fd950217b3 
} 
app.session.metrics.interact/
SERIES_FILTER_REMOVE_PILL
Tracks the removal of a dimension filter from a series through the Filters pill on the Analysis panel.
{
action: SERIES_FILTER_REMOVE_PILL 
app: search 
context: analysis 
customInfo: {
app: metrics-analysis 
commitHash: f6dd0f5fd25c9db2b79bad5557ba703b194351b8 
version: 2.0.0 
} 
numFilters: 1 
page: analysis_workspace 
seriesId: ed08e1e2-5a89-48b6-9789-066e83f6a918 
type: view/UPDATE_SERIES 
viewId: vbc755db2-4120-4af6-9b83-75fd950217b3 
} 
app.session.metrics.interact/
SERIES_FILTER_UPDATE
Tracks updates to a dimension filter for a series.
{
accessor: METRICS 
action: SERIES_FILTER_UPDATE 
app: search 
context: analysis 
customInfo: {
app: metrics-analysis 
commitHash: f6dd0f5fd25c9db2b79bad5557ba703b194351b8 
version: 2.0.0 
} 
numFilters: 1 
numMeasures: 1 
numSeries: 3 
page: analysis_workspace 
seriesHasSplit: true 
seriesId: ed08e1e2-5a89-48b6-9789-066e83f6a918 
type: view/UPDATE_SERIES 
value: {
memberCount: 3 
type: include 
wildcardCount: 0 
} 
viewId: vbc755db2-4120-4af6-9b83-75fd950217b3 
} 
app.session.metrics.interact/
SERIES_REMOVE
Tracks the removal of a series from a chart.
{
accessor: METRICS 
action: SERIES_REMOVE 
app: search 
context: analysis 
customInfo: {
app: metrics-analysis 
commitHash: f6dd0f5fd25c9db2b79bad5557ba703b194351b8 
version: 2.0.0 
} 
numFilters: 0 
numMeasures: 1 
numSeries: 3 
page: analysis_workspace 
seriesHasSplit: false 
seriesId: 5b2c9d78-b1ac-4878-b432-a8596368a3f8 
type: view/UPDATE_SERIES 
value: 5b2c9d78-b1ac-4878-b432-a8596368a3f8 
viewId: vbc755db2-4120-4af6-9b83-75fd950217b3 
} 
app.session.metrics.interact/
SERIES_UPDATE_AGGREGATION
Tracks updates to the default aggregation of a series.
{
accessor: METRICS 
action: SERIES_UPDATE_AGGREGATION 
app: search 
context: analysis 
customInfo: { 
app: metrics-analysis 
commitHash: f6dd0f5fd25c9db2b79bad5557ba703b194351b8 
version: 2.0.0 
} 
numFilters: 0 
numMeasures: 1 
numSeries: 3 
page: analysis_workspace 
seriesHasSplit: false 
seriesId: ed08e1e2-5a89-48b6-9789-066e83f6a918 
type: view/UPDATE_SERIES 
value: stdev 
viewId: vbc755db2-4120-4af6-9b83-75fd950217b3 
} 
app.session.metrics.interact/
SERIES_UPDATE_AXIS
Tracks shifting the y-axis to the right side of the chart for an individual series.
{ 
accessor: METRICS 
action: SERIES_UPDATE_AXIS 
app: search 
context: analysis 
customInfo: { 
app: metrics-analysis 
commitHash: f6dd0f5fd25c9db2b79bad5557ba703b194351b8 
version: 2.0.0 
} 
numFilters: 0 
numMeasures: 1 
numSeries: 3 
page: analysis_workspace 
seriesHasSplit: true 
seriesId: ed08e1e2-5a89-48b6-9789-066e83f6a918 
type: view/UPDATE_SERIES 
value: right 
viewId: vbc755db2-4120-4af6-9b83-75fd950217b3 
} 
app.session.metrics.interact/
SERIES_UPDATE_SPLIT
Tracks splitting a series by a dimension.
{ 
accessor: METRICS 
action: SERIES_UPDATE_SPLIT 
app: search 
context: analysis 
customInfo: { 
app: metrics-analysis 
commitHash: f6dd0f5fd25c9db2b79bad5557ba703b194351b8 
version: 2.0.0 
} 
numFilters: 0 
numMeasures: 1 
numSeries: 3 
page: analysis_workspace 
seriesHasSplit: true 
seriesId: ed08e1e2-5a89-48b6-9789-066e83f6a918 
type: view/UPDATE_SERIES 
value: null 
viewId: vbc755db2-4120-4af6-9b83-75fd950217b3 
} 
app.session.metrics.interact/
SERIES_UPDATE_TIMESHIFT
Measures time shift selections for series on a chart.
{
accessor: METRICS 
action: SERIES_UPDATE_TIMESHIFT 
app: search 
context: analysis 
customInfo: {
app: metrics-analysis 
commitHash: f6dd0f5fd25c9db2b79bad5557ba703b194351b8 
version: 2.0.0 
} 
numFilters: 0 
numMeasures: 1 
numSeries: 3 
page: analysis_workspace 
seriesHasSplit: true 
seriesId: ed08e1e2-5a89-48b6-9789-066e83f6a918 
type: view/UPDATE_SERIES 
value: -30m 
viewId: vbc755db2-4120-4af6-9b83-75fd950217b3 
} 
app.session.metrics.interact/
TRACK_SELECT_MEASURE
Measures selection and other metrics currently being viewed.
{
"context": "discover",
"customInfo": {
"app": "metrics-analysis",
"version": "0.20.0",
"commitHash": "2e093684ad2ada74b7cd8b5b5cf22d83e5ae8888"
},
"page": "analysis_workspace",
"app": "search",
"action": "TRACK_SELECT_MEASURE"
}
app.session.metrics.process/
analysis-create-alert
Measures alert creation status.
{
"action": "analysis-create-alert",
"status": "success",
"context": "analysis",
"customInfo": {
"app": "metrics-analysis",
"commitHash": "dfaff67acb4b2cce2cdb0824732ed31bec050f04",
"version": "0.20.0"
},
"app": "search",
"page": "analysis_workspace"
}
app.session.metrics.process/
EXECUTE_QUERY
Reports execution of chart queries.
{
"elapsed": 717,
"page": "analysis_workspace",
"viewId": "v78ffa7f3-1676-4496-a78b-7ed9eb5beacd",
"customInfo": {
"app": "metrics-analysis",
"version": "0.20.0",
"commitHash": "2e093684ad2ada74b7cd8b5b5cf22d83e5ae8888"
},
"action": "EXECUTE_QUERY",
"query": {
"timeComparison": null,
"limit": {
"type": "max",
"count": 5
},
"accessor": "METRICS",
"aggregations": [
{
"aggregation": "avg",
"alias": "Avg"
}
],
"timeRange": {
"latest": 1527200581.33,
"earliest": 1527198781.33
}
},
"context": "analysis",
"app": "search",
"status": "completed"
}
app.session.metrics.process/
instrumentation/TRACK_FEATURE_FLAGS
Tracks the enabling and disabling of features through the feature flags mechanism.
{
"context": [
"enable-data-datasets"
],
"customInfo": {
"app": "metrics-analysis",
"version": "0.20.0",
"commitHash": "2e093684ad2ada74b7cd8b5b5cf22d83e5ae8888"
},
"page": "analysis_workspace",
"app": "search",
"action": "instrumentation/TRACK_FEATURE_FLAGS"
}
app.session.metrics.process/
LOAD_CATALOG
Measures the catalog loading process by data access type.
{
"elapsed": 286,
"page": "analysis_workspace",
"app": "search",
"status": "completed",
"action": "LOAD_CATALOG",
"customInfo": {
"app": "metrics-analysis",
"version": "0.20.0",
"commitHash": "2e093684ad2ada74b7cd8b5b5cf22d83e5ae8888"
},
"context": "analysis",
"sourceType": "METRICS",
"count": 16
}
PREVIOUS
Troubleshoot the Splunk Metrics Workspace
  NEXT
Release notes for the Splunk Metrics Workspace

This documentation applies to the following versions of Splunk® Metrics Workspace: 1.1.6, 1.1.7


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters