argus-api-client 0.4.3__tar.gz → 0.5.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,348 @@
1
+ Metadata-Version: 2.1
2
+ Name: argus-api-client
3
+ Version: 0.5.0
4
+ Summary: A Python API client library for the Argus alert aggregator server
5
+ Author-email: Sikt - Kunnskapssektorens Tjenesteleverandør <kontakt@sikt.no>
6
+ License:
7
+ Apache License
8
+ Version 2.0, January 2004
9
+ https://www.apache.org/licenses/
10
+
11
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
12
+
13
+ 1. Definitions.
14
+
15
+ "License" shall mean the terms and conditions for use, reproduction,
16
+ and distribution as defined by Sections 1 through 9 of this document.
17
+
18
+ "Licensor" shall mean the copyright owner or entity authorized by
19
+ the copyright owner that is granting the License.
20
+
21
+ "Legal Entity" shall mean the union of the acting entity and all
22
+ other entities that control, are controlled by, or are under common
23
+ control with that entity. For the purposes of this definition,
24
+ "control" means (i) the power, direct or indirect, to cause the
25
+ direction or management of such entity, whether by contract or
26
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
27
+ outstanding shares, or (iii) beneficial ownership of such entity.
28
+
29
+ "You" (or "Your") shall mean an individual or Legal Entity
30
+ exercising permissions granted by this License.
31
+
32
+ "Source" form shall mean the preferred form for making modifications,
33
+ including but not limited to software source code, documentation
34
+ source, and configuration files.
35
+
36
+ "Object" form shall mean any form resulting from mechanical
37
+ transformation or translation of a Source form, including but
38
+ not limited to compiled object code, generated documentation,
39
+ and conversions to other media types.
40
+
41
+ "Work" shall mean the work of authorship, whether in Source or
42
+ Object form, made available under the License, as indicated by a
43
+ copyright notice that is included in or attached to the work
44
+ (an example is provided in the Appendix below).
45
+
46
+ "Derivative Works" shall mean any work, whether in Source or Object
47
+ form, that is based on (or derived from) the Work and for which the
48
+ editorial revisions, annotations, elaborations, or other modifications
49
+ represent, as a whole, an original work of authorship. For the purposes
50
+ of this License, Derivative Works shall not include works that remain
51
+ separable from, or merely link (or bind by name) to the interfaces of,
52
+ the Work and Derivative Works thereof.
53
+
54
+ "Contribution" shall mean any work of authorship, including
55
+ the original version of the Work and any modifications or additions
56
+ to that Work or Derivative Works thereof, that is intentionally
57
+ submitted to Licensor for inclusion in the Work by the copyright owner
58
+ or by an individual or Legal Entity authorized to submit on behalf of
59
+ the copyright owner. For the purposes of this definition, "submitted"
60
+ means any form of electronic, verbal, or written communication sent
61
+ to the Licensor or its representatives, including but not limited to
62
+ communication on electronic mailing lists, source code control systems,
63
+ and issue tracking systems that are managed by, or on behalf of, the
64
+ Licensor for the purpose of discussing and improving the Work, but
65
+ excluding communication that is conspicuously marked or otherwise
66
+ designated in writing by the copyright owner as "Not a Contribution."
67
+
68
+ "Contributor" shall mean Licensor and any individual or Legal Entity
69
+ on behalf of whom a Contribution has been received by Licensor and
70
+ subsequently incorporated within the Work.
71
+
72
+ 2. Grant of Copyright License. Subject to the terms and conditions of
73
+ this License, each Contributor hereby grants to You a perpetual,
74
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
75
+ copyright license to reproduce, prepare Derivative Works of,
76
+ publicly display, publicly perform, sublicense, and distribute the
77
+ Work and such Derivative Works in Source or Object form.
78
+
79
+ 3. Grant of Patent License. Subject to the terms and conditions of
80
+ this License, each Contributor hereby grants to You a perpetual,
81
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
82
+ (except as stated in this section) patent license to make, have made,
83
+ use, offer to sell, sell, import, and otherwise transfer the Work,
84
+ where such license applies only to those patent claims licensable
85
+ by such Contributor that are necessarily infringed by their
86
+ Contribution(s) alone or by combination of their Contribution(s)
87
+ with the Work to which such Contribution(s) was submitted. If You
88
+ institute patent litigation against any entity (including a
89
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
90
+ or a Contribution incorporated within the Work constitutes direct
91
+ or contributory patent infringement, then any patent licenses
92
+ granted to You under this License for that Work shall terminate
93
+ as of the date such litigation is filed.
94
+
95
+ 4. Redistribution. You may reproduce and distribute copies of the
96
+ Work or Derivative Works thereof in any medium, with or without
97
+ modifications, and in Source or Object form, provided that You
98
+ meet the following conditions:
99
+
100
+ (a) You must give any other recipients of the Work or
101
+ Derivative Works a copy of this License; and
102
+
103
+ (b) You must cause any modified files to carry prominent notices
104
+ stating that You changed the files; and
105
+
106
+ (c) You must retain, in the Source form of any Derivative Works
107
+ that You distribute, all copyright, patent, trademark, and
108
+ attribution notices from the Source form of the Work,
109
+ excluding those notices that do not pertain to any part of
110
+ the Derivative Works; and
111
+
112
+ (d) If the Work includes a "NOTICE" text file as part of its
113
+ distribution, then any Derivative Works that You distribute must
114
+ include a readable copy of the attribution notices contained
115
+ within such NOTICE file, excluding those notices that do not
116
+ pertain to any part of the Derivative Works, in at least one
117
+ of the following places: within a NOTICE text file distributed
118
+ as part of the Derivative Works; within the Source form or
119
+ documentation, if provided along with the Derivative Works; or,
120
+ within a display generated by the Derivative Works, if and
121
+ wherever such third-party notices normally appear. The contents
122
+ of the NOTICE file are for informational purposes only and
123
+ do not modify the License. You may add Your own attribution
124
+ notices within Derivative Works that You distribute, alongside
125
+ or as an addendum to the NOTICE text from the Work, provided
126
+ that such additional attribution notices cannot be construed
127
+ as modifying the License.
128
+
129
+ You may add Your own copyright statement to Your modifications and
130
+ may provide additional or different license terms and conditions
131
+ for use, reproduction, or distribution of Your modifications, or
132
+ for any such Derivative Works as a whole, provided Your use,
133
+ reproduction, and distribution of the Work otherwise complies with
134
+ the conditions stated in this License.
135
+
136
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
137
+ any Contribution intentionally submitted for inclusion in the Work
138
+ by You to the Licensor shall be under the terms and conditions of
139
+ this License, without any additional terms or conditions.
140
+ Notwithstanding the above, nothing herein shall supersede or modify
141
+ the terms of any separate license agreement you may have executed
142
+ with Licensor regarding such Contributions.
143
+
144
+ 6. Trademarks. This License does not grant permission to use the trade
145
+ names, trademarks, service marks, or product names of the Licensor,
146
+ except as required for reasonable and customary use in describing the
147
+ origin of the Work and reproducing the content of the NOTICE file.
148
+
149
+ 7. Disclaimer of Warranty. Unless required by applicable law or
150
+ agreed to in writing, Licensor provides the Work (and each
151
+ Contributor provides its Contributions) on an "AS IS" BASIS,
152
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
153
+ implied, including, without limitation, any warranties or conditions
154
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
155
+ PARTICULAR PURPOSE. You are solely responsible for determining the
156
+ appropriateness of using or redistributing the Work and assume any
157
+ risks associated with Your exercise of permissions under this License.
158
+
159
+ 8. Limitation of Liability. In no event and under no legal theory,
160
+ whether in tort (including negligence), contract, or otherwise,
161
+ unless required by applicable law (such as deliberate and grossly
162
+ negligent acts) or agreed to in writing, shall any Contributor be
163
+ liable to You for damages, including any direct, indirect, special,
164
+ incidental, or consequential damages of any character arising as a
165
+ result of this License or out of the use or inability to use the
166
+ Work (including but not limited to damages for loss of goodwill,
167
+ work stoppage, computer failure or malfunction, or any and all
168
+ other commercial damages or losses), even if such Contributor
169
+ has been advised of the possibility of such damages.
170
+
171
+ 9. Accepting Warranty or Additional Liability. While redistributing
172
+ the Work or Derivative Works thereof, You may choose to offer,
173
+ and charge a fee for, acceptance of support, warranty, indemnity,
174
+ or other liability obligations and/or rights consistent with this
175
+ License. However, in accepting such obligations, You may act only
176
+ on Your own behalf and on Your sole responsibility, not on behalf
177
+ of any other Contributor, and only if You agree to indemnify,
178
+ defend, and hold each Contributor harmless for any liability
179
+ incurred by, or claims asserted against, such Contributor by reason
180
+ of your accepting any such warranty or additional liability.
181
+
182
+ END OF TERMS AND CONDITIONS
183
+
184
+ Copyright 2020 Uninett AS
185
+
186
+ Licensed under the Apache License, Version 2.0 (the "License");
187
+ you may not use this file except in compliance with the License.
188
+ You may obtain a copy of the License at
189
+
190
+ https://www.apache.org/licenses/LICENSE-2.0
191
+
192
+ Unless required by applicable law or agreed to in writing, software
193
+ distributed under the License is distributed on an "AS IS" BASIS,
194
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
195
+ See the License for the specific language governing permissions and
196
+ limitations under the License.
197
+
198
+ Classifier: License :: OSI Approved :: Apache Software License
199
+ Classifier: Programming Language :: Python :: 3
200
+ Classifier: Programming Language :: Python :: 3.7
201
+ Classifier: Programming Language :: Python :: 3.8
202
+ Classifier: Programming Language :: Python :: 3.9
203
+ Classifier: Programming Language :: Python :: 3.10
204
+ Classifier: Programming Language :: Python :: 3.11
205
+ Requires-Python: >=3.7
206
+ Description-Content-Type: text/markdown
207
+ License-File: LICENSE
208
+ Requires-Dist: simple_rest_client
209
+ Requires-Dist: iso8601
210
+
211
+ # Argus API Client
212
+
213
+ This is the official Python client library for the
214
+ [Argus](https://github.com/Uninett/Argus) API server.
215
+
216
+ The Argus server is an incident registry, capable of aggregating alerts from
217
+ multiple source systems. Argus also can send event notifications (via e-mail,
218
+ SMS, etc.) when incidents are created or resolved.
219
+
220
+ ## Usage examples
221
+
222
+ The pyargus library models [the official API endoints of
223
+ Argus](https://argus-server.readthedocs.io/en/latest/api.html) as methods on an
224
+ API client object.
225
+
226
+ At the moment, only the methods and models needed to interact with
227
+ incident-related endpoints are supported.
228
+
229
+ The `Client` class is found in `pyargus.client`, and the various supported data
230
+ models, such as `Incident`, `Event`, `Acknowledgement` and `SourceSystem`, are
231
+ implemented in `pyargus.models`.
232
+
233
+ ### Listing open incidents that have not been acknowledged
234
+
235
+ ```pycon
236
+ >>> from pyargus.client import Client
237
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
238
+ >>> for incident in c.get_incidents(open=True, acked=False):
239
+ ... print(incident)
240
+ ...
241
+ Incident(pk=4, start_time=datetime.datetime(2021, 4, 4, 16, 37, 43, 293726, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='202430', details_url='http://localhost/search/event/202430', description='uninett-gsw2 BGP session with 158.38.3.112 is DOWN', level=5, ticket_url='', tags={'location': 'Teknobyen Innovasjonssenter', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'bgpState', 'alert_type': 'bgpDown', 'room': '100', 'organization': 'uninett.srv', 'host': 'uninett-gsw2.uninett.no'}, stateful=True, open=True, acked=False)
242
+ Incident(pk=3, start_time=datetime.datetime(2021, 4, 4, 16, 32, 53, 128780, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='202429', details_url='http://localhost/search/event/202429', description='uninett-gsw1 BGP session with 158.38.3.112 is DOWN', level=5, ticket_url='', tags={'location': 'Teknobyen Innovasjonssenter', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'bgpState', 'alert_type': 'bgpDown', 'host': 'uninett-gsw1.uninett.no', 'room': '100', 'organization': 'uninett.srv'}, stateful=True, open=True, acked=False)
243
+ Incident(pk=2, start_time=datetime.datetime(2017, 8, 31, 14, 58, 31, 118794, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='184296', details_url='http://localhost/search/event/184296', description='Link DOWN on Gi0/3 at oldsmobile.lab (Simple is better than complex)', level=5, ticket_url='', tags={'room': '113', 'location': 'Teknobyen Innovasjonssenter', 'organization': 'uninett.testlab', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'linkState', 'alert_type': 'linkDown', 'host': 'oldsmobile.lab.uninett.no', 'interface': 'Gi0/3'}, stateful=True, open=True, acked=False)
244
+ ```
245
+
246
+ As you can see, the arguments given to `get_incidents()` are translated
247
+ verbatim into the arguments supported by the `/incidents` endpoint in the API.
248
+
249
+ ### List only "my" incidents
250
+
251
+ The incidents API also has an `/incidents/mine` endpoint, which works just like
252
+ the `/incidents` endpoint, but searches only the incidents that were posted
253
+ by the connecting user. This is useful for glue services, when they need to
254
+ compare the list of open Argus incidents it has produced with the current list
255
+ of active alerts in its source system.
256
+
257
+ Example:
258
+
259
+ ```pycon
260
+ >>> from pyargus.client import Client
261
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
262
+ >>> for incident in c.get_my_incidents(open=True, acked=False):
263
+ ... print(incident)
264
+ ...
265
+ Incident(pk=3, start_time=datetime.datetime(2021, 4, 4, 16, 32, 53, 128780, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=3, name='foobar, type='nav', user=4, base_url='http://localhost/'), source_incident_id='2716057', details_url='http://localhost/search/event/2716057', description='uninett-gsw1 BGP session with 158.38.3.112 is DOWN', level=5, ticket_url='', tags={'location': 'Teknobyen Innovasjonssenter', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'bgpState', 'alert_type': 'bgpDown', 'host': 'uninett-gsw1.uninett.no', 'room': '100', 'organization': 'uninett.srv'}, stateful=True, open=True, acked=False)
266
+ ```
267
+
268
+ ### Post a new incident
269
+
270
+ ```pycon
271
+ >>> from pyargus.client import Client
272
+ >>> from pyargus.models import Incident
273
+ >>> from datetime import datetime
274
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
275
+ >>> i = Incident(
276
+ ... description="The earth was demolished to make way for a hyperspace bypass",
277
+ ... start_time=datetime.now(),
278
+ ... tags={
279
+ ... "host": "earth.example.org",
280
+ ... }
281
+ ... )
282
+ >>> c.post_incident(i)
283
+ Incident(pk=8, start_time=datetime.datetime(2021, 4, 22, 11, 41, 53, 580947, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=None, source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='', details_url='', description='The earth was demolished to make way for a hyperspace bypass', level=5, ticket_url='', tags={'host': 'earth.example.org'}, stateful=False, open=False, acked=False)
284
+ ```
285
+
286
+ The `post_incident()` method returns the full `Incident` record, as stored in
287
+ Argus. If you need it, you can get the incident ID from the the primary key
288
+ attribute `pk`, in case you need to address it directly later.
289
+
290
+ ### Close an existing incident
291
+
292
+ Incidents are closed by posting a *END* type event to an incident's event
293
+ log, with an optional timestamp. The `Client` class provides the follow
294
+ convenience method for this operation:
295
+
296
+ ```pycon
297
+ >>> from pyargus.client import Client
298
+ >>> from datetime import datetime
299
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
300
+ >>> c.resolve_incident(incident=8, description="The demolition was cancelled", timestamp=datetime.now())
301
+ Event(pk=10, actor='testnav', description='The demolition was cancelled', incident=8, received=datetime.datetime(2021, 4, 22, 11, 47, 11, 978438, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), timestamp=datetime.datetime(2021, 4, 22, 11, 47, 11, 946076, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), type='END')
302
+ ```
303
+
304
+ ### Modify an existing incident
305
+
306
+ Argus does not allow modification of most incident attributes, but things
307
+ like the tag list can be changed. Modifications are made by constructing an
308
+ `Incident` object with the `pk` attribute set to the id of the incident you
309
+ wish you modify, and then adding values to the attributes you wish to modify:
310
+
311
+ ```pycon
312
+ >>> from pyargus.client import Client
313
+ >>> from pyargus.models import Incident
314
+ >>> from datetime import datetime
315
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
316
+ >>> i = Incident(
317
+ ... pk=8,
318
+ ... tags={
319
+ ... "host": "earth.example.org",
320
+ ... "location": "Milky way",
321
+ ... }
322
+ ... )
323
+ >>> c.update_incident(i)
324
+ Incident(pk=8, start_time=datetime.datetime(2021, 4, 22, 11, 41, 53, 580947, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=None, source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='', details_url='', description='The earth was demolished to make way for a hyperspace bypass', level=None, ticket_url='', tags={'host': 'earth.example.org', 'location': 'Milky way'}, stateful=False, open=False, acked=False)
325
+
326
+ ```
327
+
328
+ ### Stateless incidents
329
+
330
+ Argus supports a concept of "stateless" incidents. Stateless incidents
331
+ represent single points in time, and do not have an end time. To explicitly
332
+ create stateless incidents, set the `end_time` attribute to the STATELESS
333
+ sentinel, like so:
334
+
335
+ ```python
336
+ from datetime import datetime
337
+ from pyargus.models import Incident, STATELESS
338
+
339
+ stateless_incident = Incident(
340
+ description="Something happened",
341
+ start_time=datetime.now(),
342
+ end_time=STATELESS
343
+ )
344
+ ```
345
+
346
+ ## BUGS
347
+
348
+ * Doesn't provide high-level error handling yet.
@@ -18,13 +18,13 @@ incident-related endpoints are supported.
18
18
 
19
19
  The `Client` class is found in `pyargus.client`, and the various supported data
20
20
  models, such as `Incident`, `Event`, `Acknowledgement` and `SourceSystem`, are
21
- implemented in `pyargus.models.
21
+ implemented in `pyargus.models`.
22
22
 
23
23
  ### Listing open incidents that have not been acknowledged
24
24
 
25
25
  ```pycon
26
26
  >>> from pyargus.client import Client
27
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
27
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
28
28
  >>> for incident in c.get_incidents(open=True, acked=False):
29
29
  ... print(incident)
30
30
  ...
@@ -39,7 +39,7 @@ verbatim into the arguments supported by the `/incidents` endpoint in the API.
39
39
  ### List only "my" incidents
40
40
 
41
41
  The incidents API also has an `/incidents/mine` endpoint, which works just like
42
- the `/incidents` endpoint, but searches onl only the incidents that were posted
42
+ the `/incidents` endpoint, but searches only the incidents that were posted
43
43
  by the connecting user. This is useful for glue services, when they need to
44
44
  compare the list of open Argus incidents it has produced with the current list
45
45
  of active alerts in its source system.
@@ -48,7 +48,7 @@ Example:
48
48
 
49
49
  ```pycon
50
50
  >>> from pyargus.client import Client
51
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
51
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
52
52
  >>> for incident in c.get_my_incidents(open=True, acked=False):
53
53
  ... print(incident)
54
54
  ...
@@ -61,7 +61,7 @@ Incident(pk=3, start_time=datetime.datetime(2021, 4, 4, 16, 32, 53, 128780, tzin
61
61
  >>> from pyargus.client import Client
62
62
  >>> from pyargus.models import Incident
63
63
  >>> from datetime import datetime
64
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
64
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
65
65
  >>> i = Incident(
66
66
  ... description="The earth was demolished to make way for a hyperspace bypass",
67
67
  ... start_time=datetime.now(),
@@ -86,14 +86,14 @@ convenience method for this operation:
86
86
  ```pycon
87
87
  >>> from pyargus.client import Client
88
88
  >>> from datetime import datetime
89
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
89
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
90
90
  >>> c.resolve_incident(incident=8, description="The demolition was cancelled", timestamp=datetime.now())
91
91
  Event(pk=10, actor='testnav', description='The demolition was cancelled', incident=8, received=datetime.datetime(2021, 4, 22, 11, 47, 11, 978438, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), timestamp=datetime.datetime(2021, 4, 22, 11, 47, 11, 946076, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), type='END')
92
92
  ```
93
93
 
94
94
  ### Modify an existing incident
95
95
 
96
- Argus does not allow modification of most an incident's attributes, but things
96
+ Argus does not allow modification of most incident attributes, but things
97
97
  like the tag list can be changed. Modifications are made by constructing an
98
98
  `Incident` object with the `pk` attribute set to the id of the incident you
99
99
  wish you modify, and then adding values to the attributes you wish to modify:
@@ -102,7 +102,7 @@ wish you modify, and then adding values to the attributes you wish to modify:
102
102
  >>> from pyargus.client import Client
103
103
  >>> from pyargus.models import Incident
104
104
  >>> from datetime import datetime
105
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
105
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
106
106
  >>> i = Incident(
107
107
  ... pk=8,
108
108
  ... tags={
@@ -0,0 +1,25 @@
1
+ [project]
2
+ name = "argus-api-client"
3
+ version = "0.5.0"
4
+ description = "A Python API client library for the Argus alert aggregator server"
5
+ readme = "README.md"
6
+ authors = [{name="Sikt - Kunnskapssektorens Tjenesteleverandør", email="kontakt@sikt.no"}]
7
+ requires-python = ">=3.7"
8
+ license = {file = "LICENSE"}
9
+ classifiers = [
10
+ "License :: OSI Approved :: Apache Software License",
11
+ "Programming Language :: Python :: 3",
12
+ "Programming Language :: Python :: 3.7",
13
+ "Programming Language :: Python :: 3.8",
14
+ "Programming Language :: Python :: 3.9",
15
+ "Programming Language :: Python :: 3.10",
16
+ "Programming Language :: Python :: 3.11",
17
+ ]
18
+ dependencies = [
19
+ "simple_rest_client",
20
+ "iso8601",
21
+ ]
22
+
23
+ [tool.setuptools.packages.find]
24
+ where = ["src"]
25
+ exclude = ["tests*"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,348 @@
1
+ Metadata-Version: 2.1
2
+ Name: argus-api-client
3
+ Version: 0.5.0
4
+ Summary: A Python API client library for the Argus alert aggregator server
5
+ Author-email: Sikt - Kunnskapssektorens Tjenesteleverandør <kontakt@sikt.no>
6
+ License:
7
+ Apache License
8
+ Version 2.0, January 2004
9
+ https://www.apache.org/licenses/
10
+
11
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
12
+
13
+ 1. Definitions.
14
+
15
+ "License" shall mean the terms and conditions for use, reproduction,
16
+ and distribution as defined by Sections 1 through 9 of this document.
17
+
18
+ "Licensor" shall mean the copyright owner or entity authorized by
19
+ the copyright owner that is granting the License.
20
+
21
+ "Legal Entity" shall mean the union of the acting entity and all
22
+ other entities that control, are controlled by, or are under common
23
+ control with that entity. For the purposes of this definition,
24
+ "control" means (i) the power, direct or indirect, to cause the
25
+ direction or management of such entity, whether by contract or
26
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
27
+ outstanding shares, or (iii) beneficial ownership of such entity.
28
+
29
+ "You" (or "Your") shall mean an individual or Legal Entity
30
+ exercising permissions granted by this License.
31
+
32
+ "Source" form shall mean the preferred form for making modifications,
33
+ including but not limited to software source code, documentation
34
+ source, and configuration files.
35
+
36
+ "Object" form shall mean any form resulting from mechanical
37
+ transformation or translation of a Source form, including but
38
+ not limited to compiled object code, generated documentation,
39
+ and conversions to other media types.
40
+
41
+ "Work" shall mean the work of authorship, whether in Source or
42
+ Object form, made available under the License, as indicated by a
43
+ copyright notice that is included in or attached to the work
44
+ (an example is provided in the Appendix below).
45
+
46
+ "Derivative Works" shall mean any work, whether in Source or Object
47
+ form, that is based on (or derived from) the Work and for which the
48
+ editorial revisions, annotations, elaborations, or other modifications
49
+ represent, as a whole, an original work of authorship. For the purposes
50
+ of this License, Derivative Works shall not include works that remain
51
+ separable from, or merely link (or bind by name) to the interfaces of,
52
+ the Work and Derivative Works thereof.
53
+
54
+ "Contribution" shall mean any work of authorship, including
55
+ the original version of the Work and any modifications or additions
56
+ to that Work or Derivative Works thereof, that is intentionally
57
+ submitted to Licensor for inclusion in the Work by the copyright owner
58
+ or by an individual or Legal Entity authorized to submit on behalf of
59
+ the copyright owner. For the purposes of this definition, "submitted"
60
+ means any form of electronic, verbal, or written communication sent
61
+ to the Licensor or its representatives, including but not limited to
62
+ communication on electronic mailing lists, source code control systems,
63
+ and issue tracking systems that are managed by, or on behalf of, the
64
+ Licensor for the purpose of discussing and improving the Work, but
65
+ excluding communication that is conspicuously marked or otherwise
66
+ designated in writing by the copyright owner as "Not a Contribution."
67
+
68
+ "Contributor" shall mean Licensor and any individual or Legal Entity
69
+ on behalf of whom a Contribution has been received by Licensor and
70
+ subsequently incorporated within the Work.
71
+
72
+ 2. Grant of Copyright License. Subject to the terms and conditions of
73
+ this License, each Contributor hereby grants to You a perpetual,
74
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
75
+ copyright license to reproduce, prepare Derivative Works of,
76
+ publicly display, publicly perform, sublicense, and distribute the
77
+ Work and such Derivative Works in Source or Object form.
78
+
79
+ 3. Grant of Patent License. Subject to the terms and conditions of
80
+ this License, each Contributor hereby grants to You a perpetual,
81
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
82
+ (except as stated in this section) patent license to make, have made,
83
+ use, offer to sell, sell, import, and otherwise transfer the Work,
84
+ where such license applies only to those patent claims licensable
85
+ by such Contributor that are necessarily infringed by their
86
+ Contribution(s) alone or by combination of their Contribution(s)
87
+ with the Work to which such Contribution(s) was submitted. If You
88
+ institute patent litigation against any entity (including a
89
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
90
+ or a Contribution incorporated within the Work constitutes direct
91
+ or contributory patent infringement, then any patent licenses
92
+ granted to You under this License for that Work shall terminate
93
+ as of the date such litigation is filed.
94
+
95
+ 4. Redistribution. You may reproduce and distribute copies of the
96
+ Work or Derivative Works thereof in any medium, with or without
97
+ modifications, and in Source or Object form, provided that You
98
+ meet the following conditions:
99
+
100
+ (a) You must give any other recipients of the Work or
101
+ Derivative Works a copy of this License; and
102
+
103
+ (b) You must cause any modified files to carry prominent notices
104
+ stating that You changed the files; and
105
+
106
+ (c) You must retain, in the Source form of any Derivative Works
107
+ that You distribute, all copyright, patent, trademark, and
108
+ attribution notices from the Source form of the Work,
109
+ excluding those notices that do not pertain to any part of
110
+ the Derivative Works; and
111
+
112
+ (d) If the Work includes a "NOTICE" text file as part of its
113
+ distribution, then any Derivative Works that You distribute must
114
+ include a readable copy of the attribution notices contained
115
+ within such NOTICE file, excluding those notices that do not
116
+ pertain to any part of the Derivative Works, in at least one
117
+ of the following places: within a NOTICE text file distributed
118
+ as part of the Derivative Works; within the Source form or
119
+ documentation, if provided along with the Derivative Works; or,
120
+ within a display generated by the Derivative Works, if and
121
+ wherever such third-party notices normally appear. The contents
122
+ of the NOTICE file are for informational purposes only and
123
+ do not modify the License. You may add Your own attribution
124
+ notices within Derivative Works that You distribute, alongside
125
+ or as an addendum to the NOTICE text from the Work, provided
126
+ that such additional attribution notices cannot be construed
127
+ as modifying the License.
128
+
129
+ You may add Your own copyright statement to Your modifications and
130
+ may provide additional or different license terms and conditions
131
+ for use, reproduction, or distribution of Your modifications, or
132
+ for any such Derivative Works as a whole, provided Your use,
133
+ reproduction, and distribution of the Work otherwise complies with
134
+ the conditions stated in this License.
135
+
136
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
137
+ any Contribution intentionally submitted for inclusion in the Work
138
+ by You to the Licensor shall be under the terms and conditions of
139
+ this License, without any additional terms or conditions.
140
+ Notwithstanding the above, nothing herein shall supersede or modify
141
+ the terms of any separate license agreement you may have executed
142
+ with Licensor regarding such Contributions.
143
+
144
+ 6. Trademarks. This License does not grant permission to use the trade
145
+ names, trademarks, service marks, or product names of the Licensor,
146
+ except as required for reasonable and customary use in describing the
147
+ origin of the Work and reproducing the content of the NOTICE file.
148
+
149
+ 7. Disclaimer of Warranty. Unless required by applicable law or
150
+ agreed to in writing, Licensor provides the Work (and each
151
+ Contributor provides its Contributions) on an "AS IS" BASIS,
152
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
153
+ implied, including, without limitation, any warranties or conditions
154
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
155
+ PARTICULAR PURPOSE. You are solely responsible for determining the
156
+ appropriateness of using or redistributing the Work and assume any
157
+ risks associated with Your exercise of permissions under this License.
158
+
159
+ 8. Limitation of Liability. In no event and under no legal theory,
160
+ whether in tort (including negligence), contract, or otherwise,
161
+ unless required by applicable law (such as deliberate and grossly
162
+ negligent acts) or agreed to in writing, shall any Contributor be
163
+ liable to You for damages, including any direct, indirect, special,
164
+ incidental, or consequential damages of any character arising as a
165
+ result of this License or out of the use or inability to use the
166
+ Work (including but not limited to damages for loss of goodwill,
167
+ work stoppage, computer failure or malfunction, or any and all
168
+ other commercial damages or losses), even if such Contributor
169
+ has been advised of the possibility of such damages.
170
+
171
+ 9. Accepting Warranty or Additional Liability. While redistributing
172
+ the Work or Derivative Works thereof, You may choose to offer,
173
+ and charge a fee for, acceptance of support, warranty, indemnity,
174
+ or other liability obligations and/or rights consistent with this
175
+ License. However, in accepting such obligations, You may act only
176
+ on Your own behalf and on Your sole responsibility, not on behalf
177
+ of any other Contributor, and only if You agree to indemnify,
178
+ defend, and hold each Contributor harmless for any liability
179
+ incurred by, or claims asserted against, such Contributor by reason
180
+ of your accepting any such warranty or additional liability.
181
+
182
+ END OF TERMS AND CONDITIONS
183
+
184
+ Copyright 2020 Uninett AS
185
+
186
+ Licensed under the Apache License, Version 2.0 (the "License");
187
+ you may not use this file except in compliance with the License.
188
+ You may obtain a copy of the License at
189
+
190
+ https://www.apache.org/licenses/LICENSE-2.0
191
+
192
+ Unless required by applicable law or agreed to in writing, software
193
+ distributed under the License is distributed on an "AS IS" BASIS,
194
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
195
+ See the License for the specific language governing permissions and
196
+ limitations under the License.
197
+
198
+ Classifier: License :: OSI Approved :: Apache Software License
199
+ Classifier: Programming Language :: Python :: 3
200
+ Classifier: Programming Language :: Python :: 3.7
201
+ Classifier: Programming Language :: Python :: 3.8
202
+ Classifier: Programming Language :: Python :: 3.9
203
+ Classifier: Programming Language :: Python :: 3.10
204
+ Classifier: Programming Language :: Python :: 3.11
205
+ Requires-Python: >=3.7
206
+ Description-Content-Type: text/markdown
207
+ License-File: LICENSE
208
+ Requires-Dist: simple_rest_client
209
+ Requires-Dist: iso8601
210
+
211
+ # Argus API Client
212
+
213
+ This is the official Python client library for the
214
+ [Argus](https://github.com/Uninett/Argus) API server.
215
+
216
+ The Argus server is an incident registry, capable of aggregating alerts from
217
+ multiple source systems. Argus also can send event notifications (via e-mail,
218
+ SMS, etc.) when incidents are created or resolved.
219
+
220
+ ## Usage examples
221
+
222
+ The pyargus library models [the official API endoints of
223
+ Argus](https://argus-server.readthedocs.io/en/latest/api.html) as methods on an
224
+ API client object.
225
+
226
+ At the moment, only the methods and models needed to interact with
227
+ incident-related endpoints are supported.
228
+
229
+ The `Client` class is found in `pyargus.client`, and the various supported data
230
+ models, such as `Incident`, `Event`, `Acknowledgement` and `SourceSystem`, are
231
+ implemented in `pyargus.models`.
232
+
233
+ ### Listing open incidents that have not been acknowledged
234
+
235
+ ```pycon
236
+ >>> from pyargus.client import Client
237
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
238
+ >>> for incident in c.get_incidents(open=True, acked=False):
239
+ ... print(incident)
240
+ ...
241
+ Incident(pk=4, start_time=datetime.datetime(2021, 4, 4, 16, 37, 43, 293726, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='202430', details_url='http://localhost/search/event/202430', description='uninett-gsw2 BGP session with 158.38.3.112 is DOWN', level=5, ticket_url='', tags={'location': 'Teknobyen Innovasjonssenter', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'bgpState', 'alert_type': 'bgpDown', 'room': '100', 'organization': 'uninett.srv', 'host': 'uninett-gsw2.uninett.no'}, stateful=True, open=True, acked=False)
242
+ Incident(pk=3, start_time=datetime.datetime(2021, 4, 4, 16, 32, 53, 128780, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='202429', details_url='http://localhost/search/event/202429', description='uninett-gsw1 BGP session with 158.38.3.112 is DOWN', level=5, ticket_url='', tags={'location': 'Teknobyen Innovasjonssenter', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'bgpState', 'alert_type': 'bgpDown', 'host': 'uninett-gsw1.uninett.no', 'room': '100', 'organization': 'uninett.srv'}, stateful=True, open=True, acked=False)
243
+ Incident(pk=2, start_time=datetime.datetime(2017, 8, 31, 14, 58, 31, 118794, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='184296', details_url='http://localhost/search/event/184296', description='Link DOWN on Gi0/3 at oldsmobile.lab (Simple is better than complex)', level=5, ticket_url='', tags={'room': '113', 'location': 'Teknobyen Innovasjonssenter', 'organization': 'uninett.testlab', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'linkState', 'alert_type': 'linkDown', 'host': 'oldsmobile.lab.uninett.no', 'interface': 'Gi0/3'}, stateful=True, open=True, acked=False)
244
+ ```
245
+
246
+ As you can see, the arguments given to `get_incidents()` are translated
247
+ verbatim into the arguments supported by the `/incidents` endpoint in the API.
248
+
249
+ ### List only "my" incidents
250
+
251
+ The incidents API also has an `/incidents/mine` endpoint, which works just like
252
+ the `/incidents` endpoint, but searches only the incidents that were posted
253
+ by the connecting user. This is useful for glue services, when they need to
254
+ compare the list of open Argus incidents it has produced with the current list
255
+ of active alerts in its source system.
256
+
257
+ Example:
258
+
259
+ ```pycon
260
+ >>> from pyargus.client import Client
261
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
262
+ >>> for incident in c.get_my_incidents(open=True, acked=False):
263
+ ... print(incident)
264
+ ...
265
+ Incident(pk=3, start_time=datetime.datetime(2021, 4, 4, 16, 32, 53, 128780, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=3, name='foobar, type='nav', user=4, base_url='http://localhost/'), source_incident_id='2716057', details_url='http://localhost/search/event/2716057', description='uninett-gsw1 BGP session with 158.38.3.112 is DOWN', level=5, ticket_url='', tags={'location': 'Teknobyen Innovasjonssenter', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'bgpState', 'alert_type': 'bgpDown', 'host': 'uninett-gsw1.uninett.no', 'room': '100', 'organization': 'uninett.srv'}, stateful=True, open=True, acked=False)
266
+ ```
267
+
268
+ ### Post a new incident
269
+
270
+ ```pycon
271
+ >>> from pyargus.client import Client
272
+ >>> from pyargus.models import Incident
273
+ >>> from datetime import datetime
274
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
275
+ >>> i = Incident(
276
+ ... description="The earth was demolished to make way for a hyperspace bypass",
277
+ ... start_time=datetime.now(),
278
+ ... tags={
279
+ ... "host": "earth.example.org",
280
+ ... }
281
+ ... )
282
+ >>> c.post_incident(i)
283
+ Incident(pk=8, start_time=datetime.datetime(2021, 4, 22, 11, 41, 53, 580947, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=None, source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='', details_url='', description='The earth was demolished to make way for a hyperspace bypass', level=5, ticket_url='', tags={'host': 'earth.example.org'}, stateful=False, open=False, acked=False)
284
+ ```
285
+
286
+ The `post_incident()` method returns the full `Incident` record, as stored in
287
+ Argus. If you need it, you can get the incident ID from the the primary key
288
+ attribute `pk`, in case you need to address it directly later.
289
+
290
+ ### Close an existing incident
291
+
292
+ Incidents are closed by posting a *END* type event to an incident's event
293
+ log, with an optional timestamp. The `Client` class provides the follow
294
+ convenience method for this operation:
295
+
296
+ ```pycon
297
+ >>> from pyargus.client import Client
298
+ >>> from datetime import datetime
299
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
300
+ >>> c.resolve_incident(incident=8, description="The demolition was cancelled", timestamp=datetime.now())
301
+ Event(pk=10, actor='testnav', description='The demolition was cancelled', incident=8, received=datetime.datetime(2021, 4, 22, 11, 47, 11, 978438, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), timestamp=datetime.datetime(2021, 4, 22, 11, 47, 11, 946076, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), type='END')
302
+ ```
303
+
304
+ ### Modify an existing incident
305
+
306
+ Argus does not allow modification of most incident attributes, but things
307
+ like the tag list can be changed. Modifications are made by constructing an
308
+ `Incident` object with the `pk` attribute set to the id of the incident you
309
+ wish you modify, and then adding values to the attributes you wish to modify:
310
+
311
+ ```pycon
312
+ >>> from pyargus.client import Client
313
+ >>> from pyargus.models import Incident
314
+ >>> from datetime import datetime
315
+ >>> c = Client(api_root_url="https://argus.example.org/api/v2", token="foobar")
316
+ >>> i = Incident(
317
+ ... pk=8,
318
+ ... tags={
319
+ ... "host": "earth.example.org",
320
+ ... "location": "Milky way",
321
+ ... }
322
+ ... )
323
+ >>> c.update_incident(i)
324
+ Incident(pk=8, start_time=datetime.datetime(2021, 4, 22, 11, 41, 53, 580947, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=None, source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='', details_url='', description='The earth was demolished to make way for a hyperspace bypass', level=None, ticket_url='', tags={'host': 'earth.example.org', 'location': 'Milky way'}, stateful=False, open=False, acked=False)
325
+
326
+ ```
327
+
328
+ ### Stateless incidents
329
+
330
+ Argus supports a concept of "stateless" incidents. Stateless incidents
331
+ represent single points in time, and do not have an end time. To explicitly
332
+ create stateless incidents, set the `end_time` attribute to the STATELESS
333
+ sentinel, like so:
334
+
335
+ ```python
336
+ from datetime import datetime
337
+ from pyargus.models import Incident, STATELESS
338
+
339
+ stateless_incident = Incident(
340
+ description="Something happened",
341
+ start_time=datetime.now(),
342
+ end_time=STATELESS
343
+ )
344
+ ```
345
+
346
+ ## BUGS
347
+
348
+ * Doesn't provide high-level error handling yet.
@@ -1,7 +1,6 @@
1
1
  LICENSE
2
2
  README.md
3
- setup.cfg
4
- setup.py
3
+ pyproject.toml
5
4
  src/argus_api_client.egg-info/PKG-INFO
6
5
  src/argus_api_client.egg-info/SOURCES.txt
7
6
  src/argus_api_client.egg-info/dependency_links.txt
@@ -10,4 +9,5 @@ src/argus_api_client.egg-info/top_level.txt
10
9
  src/pyargus/__init__.py
11
10
  src/pyargus/api.py
12
11
  src/pyargus/client.py
13
- src/pyargus/models.py
12
+ src/pyargus/models.py
13
+ tests/test_api.py
@@ -2,6 +2,8 @@ from __future__ import annotations
2
2
  from dataclasses import dataclass
3
3
  from datetime import datetime
4
4
  from iso8601 import parse_date
5
+ import inspect
6
+
5
7
 
6
8
  # STATELESS is a sentinel used as an `end_time` value to explicitly indicate that an
7
9
  # incident is in fact stateless. To the Argus API, this is represented by a null/None
@@ -46,6 +48,7 @@ class Incident:
46
48
  stateful: bool = None
47
49
  open: bool = None
48
50
  acked: bool = None
51
+ metadata: dict = None
49
52
 
50
53
  @classmethod
51
54
  def from_json(cls, data: dict) -> Incident:
@@ -67,7 +70,13 @@ class Incident:
67
70
  tags = dict(tag.split("=", maxsplit=1) for tag in tags)
68
71
  kwargs["tags"] = tags
69
72
 
70
- return cls(**kwargs)
73
+ return cls(
74
+ **{
75
+ key: value
76
+ for key, value in kwargs.items()
77
+ if key in inspect.signature(cls).parameters
78
+ }
79
+ )
71
80
 
72
81
  def to_json(self) -> dict:
73
82
  """Despite the name, this serializes this object into a dict that is suitable
@@ -0,0 +1,13 @@
1
+ import pytest
2
+ from pyargus import api
3
+
4
+
5
+ def test_connect_should_return_api_client():
6
+ client = api.connect("random", "token")
7
+ assert client
8
+
9
+
10
+ def test_api_client_with_bad_args_should_fail():
11
+ client = api.connect("random", "token")
12
+ with pytest.raises(Exception):
13
+ response = client.incidents.list_open_unacked()
@@ -1,156 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: argus-api-client
3
- Version: 0.4.3
4
- Summary: A Python API client library for the Argus alert aggregator server
5
- Home-page: https://github.com/Uninett/pyargus
6
- Author: Morten Brekkevold
7
- License: Apache-2.0
8
- Keywords: api,argus,client
9
- Platform: UNKNOWN
10
- Classifier: License :: OSI Approved :: Apache Software License
11
- Classifier: Programming Language :: Python :: 3
12
- Classifier: Programming Language :: Python :: 3.7
13
- Requires-Python: <4,>=3.7
14
- Description-Content-Type: text/markdown
15
- License-File: LICENSE
16
-
17
- # Argus API Client
18
-
19
- This is the official Python client library for the
20
- [Argus](https://github.com/Uninett/Argus) API server.
21
-
22
- The Argus server is an incident registry, capable of aggregating alerts from
23
- multiple source systems. Argus also can send event notifications (via e-mail,
24
- SMS, etc.) when incidents are created or resolved.
25
-
26
- ## Usage examples
27
-
28
- The pyargus library models [the official API endoints of
29
- Argus](https://argus-server.readthedocs.io/en/latest/api.html) as methods on an
30
- API client object.
31
-
32
- At the moment, only the methods and models needed to interact with
33
- incident-related endpoints are supported.
34
-
35
- The `Client` class is found in `pyargus.client`, and the various supported data
36
- models, such as `Incident`, `Event`, `Acknowledgement` and `SourceSystem`, are
37
- implemented in `pyargus.models.
38
-
39
- ### Listing open incidents that have not been acknowledged
40
-
41
- ```pycon
42
- >>> from pyargus.client import Client
43
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
44
- >>> for incident in c.get_incidents(open=True, acked=False):
45
- ... print(incident)
46
- ...
47
- Incident(pk=4, start_time=datetime.datetime(2021, 4, 4, 16, 37, 43, 293726, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='202430', details_url='http://localhost/search/event/202430', description='uninett-gsw2 BGP session with 158.38.3.112 is DOWN', level=5, ticket_url='', tags={'location': 'Teknobyen Innovasjonssenter', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'bgpState', 'alert_type': 'bgpDown', 'room': '100', 'organization': 'uninett.srv', 'host': 'uninett-gsw2.uninett.no'}, stateful=True, open=True, acked=False)
48
- Incident(pk=3, start_time=datetime.datetime(2021, 4, 4, 16, 32, 53, 128780, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='202429', details_url='http://localhost/search/event/202429', description='uninett-gsw1 BGP session with 158.38.3.112 is DOWN', level=5, ticket_url='', tags={'location': 'Teknobyen Innovasjonssenter', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'bgpState', 'alert_type': 'bgpDown', 'host': 'uninett-gsw1.uninett.no', 'room': '100', 'organization': 'uninett.srv'}, stateful=True, open=True, acked=False)
49
- Incident(pk=2, start_time=datetime.datetime(2017, 8, 31, 14, 58, 31, 118794, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='184296', details_url='http://localhost/search/event/184296', description='Link DOWN on Gi0/3 at oldsmobile.lab (Simple is better than complex)', level=5, ticket_url='', tags={'room': '113', 'location': 'Teknobyen Innovasjonssenter', 'organization': 'uninett.testlab', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'linkState', 'alert_type': 'linkDown', 'host': 'oldsmobile.lab.uninett.no', 'interface': 'Gi0/3'}, stateful=True, open=True, acked=False)
50
- ```
51
-
52
- As you can see, the arguments given to `get_incidents()` are translated
53
- verbatim into the arguments supported by the `/incidents` endpoint in the API.
54
-
55
- ### List only "my" incidents
56
-
57
- The incidents API also has an `/incidents/mine` endpoint, which works just like
58
- the `/incidents` endpoint, but searches onl only the incidents that were posted
59
- by the connecting user. This is useful for glue services, when they need to
60
- compare the list of open Argus incidents it has produced with the current list
61
- of active alerts in its source system.
62
-
63
- Example:
64
-
65
- ```pycon
66
- >>> from pyargus.client import Client
67
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
68
- >>> for incident in c.get_my_incidents(open=True, acked=False):
69
- ... print(incident)
70
- ...
71
- Incident(pk=3, start_time=datetime.datetime(2021, 4, 4, 16, 32, 53, 128780, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=3, name='foobar, type='nav', user=4, base_url='http://localhost/'), source_incident_id='2716057', details_url='http://localhost/search/event/2716057', description='uninett-gsw1 BGP session with 158.38.3.112 is DOWN', level=5, ticket_url='', tags={'location': 'Teknobyen Innovasjonssenter', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'bgpState', 'alert_type': 'bgpDown', 'host': 'uninett-gsw1.uninett.no', 'room': '100', 'organization': 'uninett.srv'}, stateful=True, open=True, acked=False)
72
- ```
73
-
74
- ### Post a new incident
75
-
76
- ```pycon
77
- >>> from pyargus.client import Client
78
- >>> from pyargus.models import Incident
79
- >>> from datetime import datetime
80
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
81
- >>> i = Incident(
82
- ... description="The earth was demolished to make way for a hyperspace bypass",
83
- ... start_time=datetime.now(),
84
- ... tags={
85
- ... "host": "earth.example.org",
86
- ... }
87
- ... )
88
- >>> c.post_incident(i)
89
- Incident(pk=8, start_time=datetime.datetime(2021, 4, 22, 11, 41, 53, 580947, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=None, source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='', details_url='', description='The earth was demolished to make way for a hyperspace bypass', level=5, ticket_url='', tags={'host': 'earth.example.org'}, stateful=False, open=False, acked=False)
90
- ```
91
-
92
- The `post_incident()` method returns the full `Incident` record, as stored in
93
- Argus. If you need it, you can get the incident ID from the the primary key
94
- attribute `pk`, in case you need to address it directly later.
95
-
96
- ### Close an existing incident
97
-
98
- Incidents are closed by posting a *END* type event to an incident's event
99
- log, with an optional timestamp. The `Client` class provides the follow
100
- convenience method for this operation:
101
-
102
- ```pycon
103
- >>> from pyargus.client import Client
104
- >>> from datetime import datetime
105
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
106
- >>> c.resolve_incident(incident=8, description="The demolition was cancelled", timestamp=datetime.now())
107
- Event(pk=10, actor='testnav', description='The demolition was cancelled', incident=8, received=datetime.datetime(2021, 4, 22, 11, 47, 11, 978438, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), timestamp=datetime.datetime(2021, 4, 22, 11, 47, 11, 946076, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), type='END')
108
- ```
109
-
110
- ### Modify an existing incident
111
-
112
- Argus does not allow modification of most an incident's attributes, but things
113
- like the tag list can be changed. Modifications are made by constructing an
114
- `Incident` object with the `pk` attribute set to the id of the incident you
115
- wish you modify, and then adding values to the attributes you wish to modify:
116
-
117
- ```pycon
118
- >>> from pyargus.client import Client
119
- >>> from pyargus.models import Incident
120
- >>> from datetime import datetime
121
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
122
- >>> i = Incident(
123
- ... pk=8,
124
- ... tags={
125
- ... "host": "earth.example.org",
126
- ... "location": "Milky way",
127
- ... }
128
- ... )
129
- >>> c.update_incident(i)
130
- Incident(pk=8, start_time=datetime.datetime(2021, 4, 22, 11, 41, 53, 580947, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=None, source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='', details_url='', description='The earth was demolished to make way for a hyperspace bypass', level=None, ticket_url='', tags={'host': 'earth.example.org', 'location': 'Milky way'}, stateful=False, open=False, acked=False)
131
-
132
- ```
133
-
134
- ### Stateless incidents
135
-
136
- Argus supports a concept of "stateless" incidents. Stateless incidents
137
- represent single points in time, and do not have an end time. To explicitly
138
- create stateless incidents, set the `end_time` attribute to the STATELESS
139
- sentinel, like so:
140
-
141
- ```python
142
- from datetime import datetime
143
- from pyargus.models import Incident, STATELESS
144
-
145
- stateless_incident = Incident(
146
- description="Something happened",
147
- start_time=datetime.now(),
148
- end_time=STATELESS
149
- )
150
- ```
151
-
152
- ## BUGS
153
-
154
- * Doesn't provide high-level error handling yet.
155
-
156
-
@@ -1,31 +0,0 @@
1
- [metadata]
2
- name = argus-api-client
3
- author = Morten Brekkevold
4
- version = attr: pyargus.VERSION
5
- description = A Python API client library for the Argus alert aggregator server
6
- long_description = file: README.md
7
- long_description_content_type = text/markdown
8
- url = https://github.com/Uninett/pyargus
9
- keywords = api, argus, client
10
- license = Apache-2.0
11
- classifiers =
12
- License :: OSI Approved :: Apache Software License
13
- Programming Language :: Python :: 3
14
- Programming Language :: Python :: 3.7
15
-
16
- [options]
17
- python_requires = >= 3.7, <4
18
- install_requires =
19
- simple_rest_client
20
- iso8601
21
- package_dir =
22
- =src
23
- packages = find:
24
-
25
- [options.packages.find]
26
- where = src
27
-
28
- [egg_info]
29
- tag_build =
30
- tag_date = 0
31
-
@@ -1,2 +0,0 @@
1
- from setuptools import setup, find_packages
2
- setup()
@@ -1,156 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: argus-api-client
3
- Version: 0.4.3
4
- Summary: A Python API client library for the Argus alert aggregator server
5
- Home-page: https://github.com/Uninett/pyargus
6
- Author: Morten Brekkevold
7
- License: Apache-2.0
8
- Keywords: api,argus,client
9
- Platform: UNKNOWN
10
- Classifier: License :: OSI Approved :: Apache Software License
11
- Classifier: Programming Language :: Python :: 3
12
- Classifier: Programming Language :: Python :: 3.7
13
- Requires-Python: <4,>=3.7
14
- Description-Content-Type: text/markdown
15
- License-File: LICENSE
16
-
17
- # Argus API Client
18
-
19
- This is the official Python client library for the
20
- [Argus](https://github.com/Uninett/Argus) API server.
21
-
22
- The Argus server is an incident registry, capable of aggregating alerts from
23
- multiple source systems. Argus also can send event notifications (via e-mail,
24
- SMS, etc.) when incidents are created or resolved.
25
-
26
- ## Usage examples
27
-
28
- The pyargus library models [the official API endoints of
29
- Argus](https://argus-server.readthedocs.io/en/latest/api.html) as methods on an
30
- API client object.
31
-
32
- At the moment, only the methods and models needed to interact with
33
- incident-related endpoints are supported.
34
-
35
- The `Client` class is found in `pyargus.client`, and the various supported data
36
- models, such as `Incident`, `Event`, `Acknowledgement` and `SourceSystem`, are
37
- implemented in `pyargus.models.
38
-
39
- ### Listing open incidents that have not been acknowledged
40
-
41
- ```pycon
42
- >>> from pyargus.client import Client
43
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
44
- >>> for incident in c.get_incidents(open=True, acked=False):
45
- ... print(incident)
46
- ...
47
- Incident(pk=4, start_time=datetime.datetime(2021, 4, 4, 16, 37, 43, 293726, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='202430', details_url='http://localhost/search/event/202430', description='uninett-gsw2 BGP session with 158.38.3.112 is DOWN', level=5, ticket_url='', tags={'location': 'Teknobyen Innovasjonssenter', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'bgpState', 'alert_type': 'bgpDown', 'room': '100', 'organization': 'uninett.srv', 'host': 'uninett-gsw2.uninett.no'}, stateful=True, open=True, acked=False)
48
- Incident(pk=3, start_time=datetime.datetime(2021, 4, 4, 16, 32, 53, 128780, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='202429', details_url='http://localhost/search/event/202429', description='uninett-gsw1 BGP session with 158.38.3.112 is DOWN', level=5, ticket_url='', tags={'location': 'Teknobyen Innovasjonssenter', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'bgpState', 'alert_type': 'bgpDown', 'host': 'uninett-gsw1.uninett.no', 'room': '100', 'organization': 'uninett.srv'}, stateful=True, open=True, acked=False)
49
- Incident(pk=2, start_time=datetime.datetime(2017, 8, 31, 14, 58, 31, 118794, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='184296', details_url='http://localhost/search/event/184296', description='Link DOWN on Gi0/3 at oldsmobile.lab (Simple is better than complex)', level=5, ticket_url='', tags={'room': '113', 'location': 'Teknobyen Innovasjonssenter', 'organization': 'uninett.testlab', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'linkState', 'alert_type': 'linkDown', 'host': 'oldsmobile.lab.uninett.no', 'interface': 'Gi0/3'}, stateful=True, open=True, acked=False)
50
- ```
51
-
52
- As you can see, the arguments given to `get_incidents()` are translated
53
- verbatim into the arguments supported by the `/incidents` endpoint in the API.
54
-
55
- ### List only "my" incidents
56
-
57
- The incidents API also has an `/incidents/mine` endpoint, which works just like
58
- the `/incidents` endpoint, but searches onl only the incidents that were posted
59
- by the connecting user. This is useful for glue services, when they need to
60
- compare the list of open Argus incidents it has produced with the current list
61
- of active alerts in its source system.
62
-
63
- Example:
64
-
65
- ```pycon
66
- >>> from pyargus.client import Client
67
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
68
- >>> for incident in c.get_my_incidents(open=True, acked=False):
69
- ... print(incident)
70
- ...
71
- Incident(pk=3, start_time=datetime.datetime(2021, 4, 4, 16, 32, 53, 128780, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=datetime.datetime(9999, 12, 31, 23, 59, 59, 999999), source=SourceSystem(pk=3, name='foobar, type='nav', user=4, base_url='http://localhost/'), source_incident_id='2716057', details_url='http://localhost/search/event/2716057', description='uninett-gsw1 BGP session with 158.38.3.112 is DOWN', level=5, ticket_url='', tags={'location': 'Teknobyen Innovasjonssenter', 'kundetjeneste': 'Nett_CNaaS', 'kunde': 'example.org', 'event_type': 'bgpState', 'alert_type': 'bgpDown', 'host': 'uninett-gsw1.uninett.no', 'room': '100', 'organization': 'uninett.srv'}, stateful=True, open=True, acked=False)
72
- ```
73
-
74
- ### Post a new incident
75
-
76
- ```pycon
77
- >>> from pyargus.client import Client
78
- >>> from pyargus.models import Incident
79
- >>> from datetime import datetime
80
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
81
- >>> i = Incident(
82
- ... description="The earth was demolished to make way for a hyperspace bypass",
83
- ... start_time=datetime.now(),
84
- ... tags={
85
- ... "host": "earth.example.org",
86
- ... }
87
- ... )
88
- >>> c.post_incident(i)
89
- Incident(pk=8, start_time=datetime.datetime(2021, 4, 22, 11, 41, 53, 580947, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=None, source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='', details_url='', description='The earth was demolished to make way for a hyperspace bypass', level=5, ticket_url='', tags={'host': 'earth.example.org'}, stateful=False, open=False, acked=False)
90
- ```
91
-
92
- The `post_incident()` method returns the full `Incident` record, as stored in
93
- Argus. If you need it, you can get the incident ID from the the primary key
94
- attribute `pk`, in case you need to address it directly later.
95
-
96
- ### Close an existing incident
97
-
98
- Incidents are closed by posting a *END* type event to an incident's event
99
- log, with an optional timestamp. The `Client` class provides the follow
100
- convenience method for this operation:
101
-
102
- ```pycon
103
- >>> from pyargus.client import Client
104
- >>> from datetime import datetime
105
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
106
- >>> c.resolve_incident(incident=8, description="The demolition was cancelled", timestamp=datetime.now())
107
- Event(pk=10, actor='testnav', description='The demolition was cancelled', incident=8, received=datetime.datetime(2021, 4, 22, 11, 47, 11, 978438, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), timestamp=datetime.datetime(2021, 4, 22, 11, 47, 11, 946076, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), type='END')
108
- ```
109
-
110
- ### Modify an existing incident
111
-
112
- Argus does not allow modification of most an incident's attributes, but things
113
- like the tag list can be changed. Modifications are made by constructing an
114
- `Incident` object with the `pk` attribute set to the id of the incident you
115
- wish you modify, and then adding values to the attributes you wish to modify:
116
-
117
- ```pycon
118
- >>> from pyargus.client import Client
119
- >>> from pyargus.models import Incident
120
- >>> from datetime import datetime
121
- >>> c = Client(api_root_url="https://argus.example.org/api/v1", token="foobar")
122
- >>> i = Incident(
123
- ... pk=8,
124
- ... tags={
125
- ... "host": "earth.example.org",
126
- ... "location": "Milky way",
127
- ... }
128
- ... )
129
- >>> c.update_incident(i)
130
- Incident(pk=8, start_time=datetime.datetime(2021, 4, 22, 11, 41, 53, 580947, tzinfo=datetime.timezone(datetime.timedelta(seconds=7200), '+02:00')), end_time=None, source=SourceSystem(pk=2, name='testnav', type='nav', user=3, base_url='http://localhost/'), source_incident_id='', details_url='', description='The earth was demolished to make way for a hyperspace bypass', level=None, ticket_url='', tags={'host': 'earth.example.org', 'location': 'Milky way'}, stateful=False, open=False, acked=False)
131
-
132
- ```
133
-
134
- ### Stateless incidents
135
-
136
- Argus supports a concept of "stateless" incidents. Stateless incidents
137
- represent single points in time, and do not have an end time. To explicitly
138
- create stateless incidents, set the `end_time` attribute to the STATELESS
139
- sentinel, like so:
140
-
141
- ```python
142
- from datetime import datetime
143
- from pyargus.models import Incident, STATELESS
144
-
145
- stateless_incident = Incident(
146
- description="Something happened",
147
- start_time=datetime.now(),
148
- end_time=STATELESS
149
- )
150
- ```
151
-
152
- ## BUGS
153
-
154
- * Doesn't provide high-level error handling yet.
155
-
156
-