Skip to content

Commit a30d979

Browse files
formatting
1 parent e428aee commit a30d979

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,31 +36,31 @@ For an example on how to parse this output, take a look at a simple example like
3636

3737
Methods
3838
-------
39-
####get_user_info(self)
39+
#### `get_user_info(self)`
4040
**Description**
4141
Get details about the current user.
4242
**Success Return Value**
4343
A dictionary containing information about the user, for example its email and the maximum number of agents it can install.
4444
**Example**
4545
[examples/print_user_info.py](examples/print_user_info.py).
4646

47-
####get_n_connected_agents(self)
47+
#### `get_n_connected_agents(self)`
4848
**Description**
4949
Return the number of agents currently connected to Sysdig Cloud for the current user.
5050
**Success Return Value**
5151
An integer number.
5252
**Example**
5353
[examples/print_user_info.py](examples/print_user_info.py).
5454

55-
####get_alerts(self)
55+
#### `get_alerts(self)`
5656
**Description**
5757
Retrieve the list of alerts configured by the user.
5858
**Success Return Value**
5959
An array of alert json objects, with the format described at [this link](https://app.sysdigcloud.com/apidocs/#!/Alerts/get_api_alerts).
6060
**Example**
6161
[examples/list_alerts.py](examples/list_alerts.py).
6262

63-
#### create_alert(self, name, description, severity, for_atleast_s, condition, segmentby = [], segment_condition = 'ANY', filter = '', notify='', enabled=True, annotations={}):
63+
#### `create_alert(self, name, description, severity, for_atleast_s, condition, segmentby = [], segment_condition = 'ANY', filter = '', notify='', enabled=True, annotations={})`
6464
**Description**
6565
Create a threshold-based alert.
6666
**Arguments**
@@ -81,7 +81,7 @@ A dictionary describing the just created alert, with the format described at [th
8181
**Example**
8282
[examples/create_alert.py](examples/create_alert.py).
8383

84-
#### add_email_notification_recipient(self, email)
84+
#### `add_email_notification_recipient(self, email)`
8585
**Description**
8686
Add a new recipient for email alert notifications.
8787
**Arguments**
@@ -92,7 +92,7 @@ A dictionary showing the updated user notifications configuration.
9292
**Example**
9393
[examples/add_notification_email.py](examples/add_notification_email.py).
9494

95-
#### create_dashboard_from_view(self, newdashname, viewname, filter)
95+
#### `create_dashboard_from_view(self, newdashname, viewname, filter)`
9696
**Description**
9797
Create a new dasboard using one of the Sysdig Cloud views as a template. You will be able to define the scope of the new dasboard.
9898
**Arguments**
@@ -105,7 +105,7 @@ A dictionary showing the details of the new dashboard.
105105
**Example**
106106
[examples/create_dashboard.py](examples/create_dashboard.py).
107107

108-
#### create_dashboard_from_dashboard(self, newdashname, templatename, filter):
108+
#### `create_dashboard_from_dashboard(self, newdashname, templatename, filter)`
109109
**Description**
110110
Create a new dasboard using one of the existing dashboards as a template. You will be able to define the scope of the new dasboard.
111111
**Arguments**
@@ -118,7 +118,7 @@ A dictionary showing the details of the new dashboard.
118118
**Example**
119119
[examples/create_dashboard.py](examples/create_dashboard.py).
120120

121-
#### get_data(self, metrics, start_ts, end_ts=0, sampling_s = 0, filter='', datasource_type='host')
121+
#### `get_data(self, metrics, start_ts, end_ts=0, sampling_s = 0, filter='', datasource_type='host')`
122122
**Description**
123123
This is the method you use to export metric data. It's flexible enough to offer both time-series and table-based data export.
124124
**Arguments**
@@ -134,31 +134,31 @@ A dictionary with the requested data. Data is organized in a list of time sample
134134
**Examples**
135135
[examples/get_data_simple.py](examples/get_data_simple.py), [examples/get_data_advanced.py](examples/get_data_advanced.py), [examples/list_hosts.py](examples/list_hosts.py).
136136

137-
#### get_data_retention_info(self)
137+
#### `get_data_retention_info(self)`
138138
**Description**
139139
Return the list of data retention intervals, with beginning and end UTC time for each of them. Sysdig Cloud performs rollups of the data it stores. This means that data is stored at different time granularities depending on how far in time it is. This call can be used to know what precision you can expect before you make a call to get_data().
140140
**Success Return Value**
141141
A dictionary containing the list of available sampling intervals.
142142
**Example**
143143
[examples/print_data_retention_info.py](examples/print_data_retention_info.py).
144144

145-
#### get_dashboards(self)
145+
#### `get_dashboards(self)`
146146
**Description**
147147
Return the list of dashboards available under the given user account. This includes the dashboards created by the user and the ones shared with her by other users.
148148
**Success Return Value**
149149
A dictionary containing the list of available sampling intervals.
150150
**Example**
151151
[examples/list_dashboards.py](examples/list_dashboards.py).
152152

153-
#### get_explore_grouping_hierarchy(self)
153+
#### `get_explore_grouping_hierarchy(self)`
154154
**Description**
155155
Return the user's current Explore gourping hierarchy.
156156
**Success Return Value**
157157
A list containing the list of the user's Explore grouping criteria.
158158
**Example**
159159
[examples/print_explore_grouping.py](examples/print_explore_grouping.py).
160160

161-
#### post_event(self, name, description='', severity=6, host='', tags={}):
161+
#### `post_event(self, name, description='', severity=6, host='', tags={})`
162162
**Description**
163163
You can use this method you use to send an event to Sysdig Cloud. The events you post are available in the Events tab in the Sysdig Cloud UI and can be overlied to charts.
164164
**Arguments**
@@ -173,7 +173,7 @@ A dictionary describing the new event.
173173
**Example**
174174
[examples/post_event.py](examples/post_event.py).
175175

176-
#### get_metrics(self)
176+
#### `get_metrics(self)`
177177
**Description**
178178
Return the metric list that can be used for data requests/alerts/dashboards.
179179
**Success Return Value**

0 commit comments

Comments
 (0)