Skip to content

Commit 7a65033

Browse files
author
Davide Schiera
committed
Fixed several linting issues.
1 parent c9fd39b commit 7a65033

File tree

2 files changed

+132
-132
lines changed

2 files changed

+132
-132
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,15 +53,15 @@ For an example on how to parse this output, take a look at a simple example like
5353
Methods
5454
-------
5555
#### `add_dashboard_panel`
56-
**`(self, dashboard, name, type, metrics, scope=None, layout=None, sort_by=None, limit=None)`**
56+
**`(self, dashboard, name, panel_type, metrics, scope=None, layout=None, sort_by=None, limit=None)`**
5757

5858
**Description**
5959
Adds a panel to the dashboard. A panel can be a time series, or a top chart (i.e. bar chart), or a number panel.
6060

6161
**Arguments**
6262
- **dashboard**: dashboard to edit
6363
- **name**: name of the new panel
64-
- **type**: type of the new panel. Valid values are: `timeSeries`, `top`, `number`
64+
- **panel_type**: type of the new panel. Valid values are: `timeSeries`, `top`, `number`
6565
- **metrics**: a list of dictionaries, specifying the metrics to show in the panel, and optionally, if there is only one metric, a grouping key to segment that metric by. A metric is any of the entries that can be found in the _Metrics_ section of the Explore page in Sysdig Cloud. Metric entries require an _aggregations_ section specifying how to aggregate the metric across time and groups of containers/hosts. A grouping key is any of the entries that can be found in the _Show_ or _Segment By_ sections of the Explore page in Sysdig Cloud. Refer to the examples section below for ready to use code snippets. Note, certain panels allow certain combinations of metrics and grouping keys:
6666
- `timeSeries`: 1 or more metrics OR 1 metric + 1 grouping key
6767
- `top`: 1 or more metrics OR 1 metric + 1 grouping key
@@ -91,7 +91,7 @@ A dictionary showing the updated user notifications configuration.
9191
[examples/add_notification_email.py](examples/add_notification_email.py).
9292

9393
#### `create_alert`
94-
**`(self, name, description, severity, for_atleast_s, condition, segmentby = [], segment_condition = 'ANY', filter = '', notify='', enabled=True, annotations={})`**
94+
**`(self, name, description, severity, for_atleast_s, condition, segmentby = [], segment_condition = 'ANY', user_filter = '', notify='', enabled=True, annotations={})`**
9595

9696
**Description**
9797
Create a threshold-based alert.
@@ -103,7 +103,7 @@ Create a threshold-based alert.
103103
- **condition**: the alert condition, as described here https://app.sysdigcloud.com/apidocs/#!/Alerts/post_api_alerts
104104
- **segmentby**: a list of Sysdig Cloud segmentation criteria that can be used to apply the alert to multiple entities. For example, segmenting a CPU alert by ['host.mac', 'proc.name'] allows to apply it to any process in any machine.
105105
- **segment_condition**: When _segmentby_ is specified (and therefore the alert will cover multiple entities) this field is used to determine when it will fire. In particular, you have two options for _segment_condition_: **ANY** (the alert will fire when at least one of the monitored entities satisfies the condition) and **ALL** (the alert will fire when all of the monitored entities satisfy the condition).
106-
- **filter**: a boolean expression combining Sysdig Cloud segmentation criteria that makes it possible to reduce the scope of the alert. For example: _kubernetes.namespace.name='production' and container.image='nginx'_.
106+
- **user_filter**: a boolean expression combining Sysdig Cloud segmentation criteria that makes it possible to reduce the scope of the alert. For example: _kubernetes.namespace.name='production' and container.image='nginx'_.
107107
- **notify**: the type of notification you want this alert to generate. Options are _EMAIL_, _SNS_, _PAGER_DUTY_, _SYSDIG_DUMP_.
108108
- **enabled**: if True, the alert will be enabled when created.
109109
- **annotations**: an optional dictionary of custom properties that you can associate to this alert for automation or management resons

0 commit comments

Comments
 (0)