Website logo
API ReferenceIntegration DirectoryOctane Blog
⌘K
🚀Welcome to Octane
⛽Sending Usage Data
Understanding Measurements
Designing Meters
Sending Usage Measurements
FAQs
💰Pricing & Credits
Price Plans
Credits
FAQs
🧑‍💻Customers & Subscriptions
Creating Customers
Customer Statuses
Customer Properties & Tags
Managing Subscriptions
FAQs
🧾Invoicing & Payments
Invoice Flow
Customize Invoicing
Dunning
Currencies
Stripe for Payments
FAQs
🎛️Integrations & Exports
Accounting
Handling Taxes
Salesforce
Slack
Data Export
📊Dashboards & Reports
End Customer Experience
Revenue Recognition
🌐Developer Resources
API Authentication
Webhooks
Accepting Payment Methods in your UI
Docs powered by Archbee
Sending Usage Data
Designing Meters

Meter Event Label Filtering

4min

ADVANCED TOPIC

This section is not necessary for out-of-the-box basic usage of the Octane platform. We recommend going through the other guides first before reading this section.

When configuring a meter using events, you have the option to define a specific set of label filters. These filters ensure that only measurements for that event whose primary labels align with these filters will be considered for the meter. This functionality enhances the adaptability of events, enabling a meter to measure a distinct subset of event measurements based on their primary labels.

How to use Meter Event Label Filters

Each specific filter allows you to either match a single label key to a value, or check that a label key exists:

Python
# Filter for measurements that set the `key` label to value `us-west-2`
filter = {
    "key": "region",
    "operation": "EQUALS",
    "value": "us-west-2",
}

# Filter for measurements that provide the `key` region 
filter = {
    "key": "region",
    "operation": "EXISTS",
}


Filters are wrapped by expressions. With expressions, you can recursively combine filters and other expressions to create more complex rules. Each expression allows you to specify either AND or OR when combining the results of the nested filters/expressions. The default expression operator is AND.

Each expression has a boolean field is_expressionthat denotes whether the nested filter is an expression or a filter. If is_expression is True, you must provide the field filters. If False, you must provide the field filter.

Python
# Filter for measurements that provide the key `size` AND 
# set the key `region` to value `us-west-2` OR `us-west-1`
expression = {
    "is_expression": True,
    "expression_operator": "AND",
    "filters": [
        {
            "is_expression": False,
            "filter": {
                "key": "size",
                "operation": "EXISTS",
            },
        },
        {
            "is_expression": True,
            "expression_operator": "OR",
            "filters": [
                {
                    "is_expression": False,
                    "filter": {
                        "key": "region",
                        "operation": "EQUALS",
                        "value": "us-west-2",
                    },
                },
                {
                    "is_expression": False,
                    "filter": {
                        "key": "region",
                        "operation": "EQUALS",
                        "value": "us-west-1",
                    },
                },
            ]
        },
    ],
}


You can additionally specify not_filter = True to match the inverse of a filter or expression.

Note: If not_filteris set to True for an "EQUALS"filter, the filter will additionally return True if the key is not provided.

Python
# Filter for measurements that do not contain the key `region`
expression = {
    "is_expression": False,
    "not_filter": True,
    "filter": {
        "key": "region",
        "operation": "EXISTS",
    },
}

# Filter for measurements that either do not set `region` value to `us-west-2`. Note: as explained above, will return True if `region` is not set.
expression = {
    "is_expression": False,
    "not_filter": True,
    "filter": {
        "key": "region",
        "operation": "EQUALS",
        "value": "us-west-2"
    },
}

# Filter for measurements that contain the key `region` but do not set it to `us-west-2` or `us-west-1`:
expression = {
    "is_expression": True,
    "expression_operator": "AND",
    "filters": [
        {
            "is_expression": False,
            "filter": {
                "key": "region",
                "operation": "EXISTS",
            },
        },
        {
            "is_expression": True,
            "expression_operator": "OR",
            "not_filter": True,
            "filters": [
                {
                    "is_expression": False,
                    "filter": {
                        "key": "region",
                        "operation": "EQUALS",
                        "value": "us-west-2",
                    },
                },
                {
                    "is_expression": False,
                    "filter": {
                        "key": "region",
                        "operation": "EQUALS",
                        "value": "us-west-1",
                    },
                },
            ]
        },
    ],
}


Creating Meter Event Label Filters

Meter event label filters can currently be created via the Create Meter API. Simply set the field event_label_filter to the intended filter.

Python
import requests
url = "https://api.cloud.getoctane.io/meters/"
payload = {
    "event_label_filter": {
        "filter": {
            "key": "region",
            "operation": "EQUALS",
            "value": "us-west-2"
        },
        "is_expression": False
    },
    "display_name": "us_west_2_meter",
    "event_name": "storage",
    "primary_labels": ["region", "size"]
}
headers = {
    "accept": "application/json",
    "content-type": "application/json",
    "authorization": "Bearer [auth_token]"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)




PREVIOUS
Event Mapping
NEXT
Editing & Archiving Meters
Docs powered by Archbee
TABLE OF CONTENTS
How to use Meter Event Label Filters
Creating Meter Event Label Filters
Docs powered by Archbee