Use metrics security to control access to time series, histograms, and delta counters.

In a large enterprise, certain data are confidential. Wavefront allows you to limit who can see or modify data in several ways.

  • Permissions are global settings.
    • Some permissions limit who can modify Wavefront objects (e.g. proxies or events). For example, users with Dashboards permission can modify all dashboards.
    • Other permissions make certain information completely invisible. For example, only users with SAML IDP Admin permission can see the Self Service SAML menu or access that page.
  • Access Control allows administrators with the right permissions fine-grained control over individual dashboards or alerts. For example, it’s possible to limit view and modify access to a Finance_2020 dashboard to just the Finance department.
  • Metrics Security supports even finer-grained control. In the example above, access to the Finance_2020 dashboard is limited to the Finance department. With metrics security, you can limit access to confidential time series, histogram and delta counter metrics to the leadership team.

Video: Metrics Security Policy

Watch this video for an overview.

How Metrics Security Protects Sensitive Data

Metrics security policy rules allows fine-grained support for limiting access to sensitive data.

Block or Allow Access

With a metrics security policy, you can block or allow access:

  • To metrics, optionally filtered by source and/or point tag
  • Based on groups, roles, and/or individual users.

When an account attempts to access metrics, the backend looks at the rules in priority order. Higher priority rules overwrite lower priority rules.

For example, assume you have two rules:

BlockRevenueNumbers 2 All metrics that start with revenue* All accounts
AllowRevenueFinance 1 All metrics that start with revenue* All accounts in Finance group

After the rules are in force, only users in the Finance group can access data that start with revenue*.

Sensitive Data Become Invisible

Data protected by a metrics security policy rule can become invisible to users.

  • Not visible in charts. The chart either includes a warning that some metrics are protected, or, if all metrics are protected, the chart shows only the message.
  • Not visible in alerts (if Secure Metrics Details is checked for the alert). The alert fires based on the complete set of metrics, and the complete set is shown in notification images by default. A checkbox allows administrators to hide alert details so that confidential metrics are not shown.
  • Not visible in auto-complete in Chart Builder, Query Editor, Metrics browser, etc.

Rule Priority and Rule Pairs

Rules are evaluated in priority order. In many cases, it’s useful to think of pairs of rules, for example:

  • First block access to all metrics for a group (Priority 2)
  • Allow access to a small set of metrics (e.g. *dev*) for that group (Priority 1)

Because Priority 1 overrides Priority 2, the group has access to a small set of metrics.

See the Examples below for some scenarios.

Alert Notifications

To protect metrics from inclusion in alert notifications, use the Secure Metrics Details check box. Wavefront looks at all metrics when determining when an alert status should change and shows them in alert notifications. When the check box is selected, details are not shown in the notification.

Derived Metrics and Events

The current implementation does not protect metrics in Derived Metrics or in Events.

Warning Messages for Protected Metrics

  • Charts in Dashboard. If certain charts in a dashboard include protected metrics, those charts display that information, as follows:
    • Some metrics protected. If some metrics in a chart are protected, the chart shows metrics but includes the following Warning message.
       Some metrics returned by this query might be excluded due to metrics security policy rules.
    • All metrics protected. If all metrics in a chart are protected, the chart shows only the following message:
       All metrics in this chart are excluded due to metrics security policy rules.
  • Chart in Edit Mode. When you edit a chart and your query result include protected metrics, the following message is displayed below the query.

     All metrics returned by this query are excluded due to metrics security policy rules.

Create a Metrics Security Policy Rule

Privileged users can create rules, change rule priority, and change the scope of each rule.

Plan Your Strategy

Before you create rules, plan your strategy.

  • Metrics Dimensions allow you to determine what to block or allow.
    • Specify one or more metric prefixes. You can specify an exact match (e.g. requests or request.) or a wildcard match (e.g. *.cpuloadav*, cpu.*).
    • Specify a combination of metric sources or point tags to narrow down the metrics. For example, you can block visibility into production environments for some developers, or you can block some development environments metrics for contractors.
  • Access allows you to allow or block access for a combination of accounts and/or groups or for roles.

See the Examples further below.

Create One or More Rules

You create a metrics security policy rule following these steps. See the annotated screenshot below for an example.

  1. From the gear icon, select Metrics Security Policy and click Create Rule
  2. In the Create Rule dialog, specify the rule parameters.
  3. Specify a descriptive name. Users might later modify the rule, so a clear name is essential.
  4. Add a description. The description is visible only when you edit the rule. The name is visible on the Metrics Security Policy page.
  5. Specify and describe the metrics:
    • You can specify the full metric name or use a wildcard character in metric names, sources, or point tags. The wildcard character alone (*) means all metrics.
    • Specify key=value pairs, for example, source="app-24" or env=dev.
    • If you want to specify multiple key=value pairs, select whether you want to combine them with and or or using the dropdown menu on the right.
  6. Specify the Access definition for the rule.
    1. Select Allow or Block from the menu.
    2. Specifying accounts, groups, or roles.
  7. Click OK.

Here’s an annotated screenshot that shows the main actions:

Annotated Edit Rule screenshot. Highlights Press Enter in Prefix / Source and Point Tag section

Manage Multiple Metrics Security Policy Rules

The following annotated screenshot gives an overview of rule management options:

screenshot, annotated with the items explained below

Here’s a tour:

  1. Click Version History to
    • Revert to an earlier version of the policy.
    • Look at information on who last edited the security policy and when that happened.
  2. Examine the Metric Prefix column to see the metrics affected by a rule.
  3. Look at the Access column to see whether the rule allows or blocks access.
  4. Click the check box to the left of a rule to select them, then use the icons above to clone or delete the selected rule.
  5. Click the check boxes to the left of multiple rules to select them, use the icons to indicate changes, and click Save to commit the changes.
  6. Select the six-dot icon to explicitly drag a rule where you want it and change rule priorities.
  7. If you’ve moved, cloned, or deleted one or more rules, use the Undo button to undo the change, or Redo to revert the undo.

Example for Metrics Security Policies

Before you start, plan your strategy. Here are some common scenarios.

Initially, a single metrics security policy rule is defined:

screenshot of default single policy

All users can access all metrics, meaning no restrictions are in place. Furthermore, if the single Allow All Metrics rule was deleted, all users will still have access to all metrics.

Example: Restrict Access to Confidential Metrics

This example restricts access to specific ranges of highly-sensitive metrics, say revenue numbers, to select groups of users.

screenshot of default single policy

The image above shows how to restrict metrics starting with revenue.* to be accessible only by members of the group Finance. The policy grants all users access to all other metrics.

  • When the metric revenue.saas is queried by a user in the Finance group, this access matches Rule 1 (Finance Group can access Revenue). The rule grants the access, so the metric is shown to the user and no other rules are consulted.

  • When the metric revenue.saas is queried by a user not in the Finance group, the access does not match Rule 1. The engine moves on to Rule 2 (No one else can access Revenue), which matches because all users belong to the Everyone group. Because the rule denies the access, the metric is not shown to the user. No other rules are consulted.

Example: Restrict Access for a Group of Users

This example restricts access for a group of users, making only a subset of the metrics in the system available to them.

screenshot of default single policy

The image above shows how to restricts access for users in the group Contractors. Those users can only query metrics tagged with the point tag env=dev. This policy imposes no restrictions on any other groups.

  • When a user belonging to group Contractors runs a query for cpu.usage tagged with env=dev, this access matches Rule 1 (Contractors can access dev environment metrics) and access is granted.
  • But when the user issues a query for cpu.usage tagged with env=prod, this access does not match Rule 1. Rule 2 (Contractors cannot access any other metrics) acts as a catch-all for users of group Contractors and denies them access to this metric.

Example: Strictly Limit Access on a Need-to-Know Basis

Some companies want to make metric accessible only to the team that needs to know about it. Access to metrics outside a team’s scope of work is disabled. Only administrators are allowed access to all metrics.

screenshot of default single policy

The image above shows how to use a set of rules to accomplish this.

  • Rule 4 (Block All Metrics by default) applies to any access that doesn’t match a higher-up rule. It denies access to all users. Users get access only when an “exception” rule with higher priority access matches.
  • Rule 3 (Allow All Metrics to Admins) grants access to all metrics to users in the Admins group.
  • Rule 2 (Allow Gadgets Team access to Gadget Metrics) grants access to any metrics starting with gadget.* to members of the Gadgets group.
  • Rule 1 (Allow Widgets Team access to Widget Metrics) grants access to any metrics starting with widget.* to members of the Widgets group.

In this example, ordering (priority) between rules 1 and 2 does not matter because describe rules for independent metric regions.

With this policy in place:

  • Members of the Widgets group are granted access if the metric starts with widget.* (Rule 1) and denied otherwise (Rule 4).
  • Members of the Gadgets group are granted access if the metric starts with gadget.* (Rule 2) and denied otherwise (Rule 4).
  • Members of the Admins group are granted access to all metrics (Rule 3).
  • Users who don’t belong to the groups covered by the rules have no access.