Parameters
The Environments object schema includes the following attributes:
Attribute | Description | Type |
|---|---|---|
name | User-defined name for the environment. | String |
id | System-generated unique identifier for an environment. | String |
environment_group_id | System-generated id of the environment group. | String |
description | User-defined description of the environment. | String |
roles | The full access roles associated with the environment. | String |
read_only_roles | Read only roles that can view the environment. | String |
created_at | Unix epoch time when the environment was created (in seconds). | Long |
created_by | The ID of the user who created the environment. | String |
updated_at | Unix epoch time when the environment was last updated (in seconds). | Long |
updated_by | The ID of the user who last updated the environment. | String |
filter | BPQL Filter to set conditions for the environment. | String |
Sample Environments Object
{
"name": "Production Crits",
"id": "60b796b886d4050040dc9192",
"environment_group_id": "63bdaabcd395ll21200c3dd55",
"roles": [
{
"id": "643d421d0961d74e3c879f13",
"name": "Operator"
}
],
"read_only_roles": [
{
"id": "921d421d0837r74e3c879g82",
"name": "Read Only"
}
],
"description": "NOC Team",
"created_at": 1622644409,
"updated_at": 1622644409,
"updated_by": "608ffeefcc86eff26b51412a",
"created_by": "608ffeefcc86eff26b51412a",
"filter": "incident_tag.priority=P1 AND source IN [nagios]"
}
Environment Groups Parameters
The Environments-groups object schema includes the following attributes:
Attribute | Description | Type |
|---|---|---|
id | System-generated unique identifier for an environment group. | String |
name | User-defined name for the environment group. | String |
environment_ids | System identifier for each environment that should belong to the environment group | Array of Strings |
Environment groups
Environments can only belong to one group at a time. If an environment has not been assigned to a custom group, it will belong to the All Environments group by default.
Adding environments to groups
Environments can be added to a group only after it has been created.
Sample Environment Groups Object
{
"id": "63eb8ae5e8acf61300f1e766",
"name": "NYC",
"environmentIds": [
"63eb8b79f8c0dd12005799bc",
"6495c2c0f8502e1200499ed5",
"6615cdec0f7e9abeb4659a26"
]
}Use Cases
Define custom Environments that help your users focus on the most relevant information to them. Common use cases include Environments that are based on areas of responsibility within IT and DevOps teams, processes, or escalation paths. For example, you can define an Environment for:
A DBA team that focuses on incidents related to production databases.
An engineering team that is responsible for incidents related to a particular set of applications.
Level-1 or NOC operators that work only on high-severity incidents.
The emergency contacts of a customer-facing service. Include only critical alerts from the service, and then set up an AutoShare to immediately notify the emergency contacts.
Creating environments via API
The basic environment builder in the BigPanda UI guides users through the creation of environments without the need for a BPQL filter. However, once an environment has been created or edited using the Environments API, the basic environment builder will no longer be available for that environment.
Environments are configured using BigPanda Query Language (BPQL) to define rules on which incidents will be grouped together. The rules construct a simple and/or boolean expression that is evaluated against the incident properties.