https://github.com/sysdiglabs/sysdig-sdk-python
Sysdig Platform Python client library
https://github.com/sysdiglabs/sysdig-sdk-python
python sysdig sysdig-monitor sysdig-secure
Last synced: 6 months ago
JSON representation
Sysdig Platform Python client library
- Host: GitHub
- URL: https://github.com/sysdiglabs/sysdig-sdk-python
- Owner: sysdiglabs
- License: mit
- Created: 2015-11-06T00:07:04.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-14T15:28:07.000Z (over 1 year ago)
- Last Synced: 2024-05-14T22:50:12.181Z (over 1 year ago)
- Topics: python, sysdig, sysdig-monitor, sysdig-secure
- Language: Python
- Homepage: https://sysdiglabs.github.io/sysdig-sdk-python
- Size: 1.74 MB
- Stars: 63
- Watchers: 53
- Forks: 43
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Sysdig Monitor/Secure Python client library
===
[](https://pypi.python.org/pypi/sdcclient)
A Python client API for Sysdig Monitor/Sysdig Secure.
This module is a wrapper around the Sysdig Monitor/Sysdig Secure APIs. It exposes most of the sysdig REST API functionality as an easy to use and easy to install Python interface. The repository includes a rich set of examples (in the [examples](examples/) subdir) that quickly address several use cases.
Installation
------------
#### Automatic with PyPI
pip install sdcclient
#### Manual (development only)
This method requires [Poetry](https://python-poetry.org/) installed
git clone https://github.com/sysdiglabs/sysdig-sdk-python.git
cd python-sdc-client
poetry install
Quick start
-----------
- If you are interested in exporting metrics data from Sysdig Monitor, take a look at [examples/get_data_simple.py](examples/get_data_simple.py) and [examples/get_data_advanced.py](examples/get_data_advanced.py).
- If you want to programmatically create an alert, refer to [examples/create_alert.py](examples/create_alert.py)
- If you want to programmatically create a dashboard, refer to [examples/create_dashboard.py](examples/create_dashboard.py)
Usage
-----
_Note:_ in order to use this API you must obtain a Sysdig Monitor/Secure API token. You can get your user's token in the _Sysdig Monitor API_ section of the settings page for [monitor](https://app.sysdigcloud.com/#/settings/user) or [secure](https://secure.sysdig.com/#/settings/user).
The library exports two classes, `SdMonitorClient` and `SdSecureClient` that are used to connect to Sysdig Monitor/Secure and execute actions. They can be instantiated like this:
``` python
from sdcclient import SdMonitorClient
api_token = "MY_API_TOKEN"
#
# Instantiate the Sysdig Monitor client
#
client = SdMonitorClient(api_token)
```
For backwards compatibility purposes, a third class `SdcClient` is exported which is an alias of `SdMonitorClient`.
Once instantiated, all the methods documented below can be called on the object.
#### Return Values
Every method in the SdMonitorClient/SdSecureClient classes returns **a list with two entries**. The first one is a boolean value indicating if the call was successful. The second entry depends on the result:
- If the call was successful, it's a dictionary reflecting the json returned by the underlying REST call
- If the call failed, it's a string describing the error
For an example on how to parse this output, take a look at a simple example like [get_data_simple.py](examples/get_data_simple.py)
Function List & Documentation
-----------------------------
**Work in progress**
Fully documented methods is in our roadmap and will be available soon.
On-Premises Installs
--------------------
For [On-Premises Sysdig Monitor installs](https://support.sysdigcloud.com/hc/en-us/articles/206519903-On-Premises-Installation-Guide), additional configuration is necessary to point to your API server rather than the default SaaS-based one, and also to easily connect when using a self-signed certificate for SSL. One way to handle this is by setting environment variables before running your Python scripts:
```
export SDC_URL='https://'
export SDC_SSL_VERIFY='false'
```
Alternatively, you can specify the additional arguments in your Python scripts as you instantiate the SDC client:
```
client = SdMonitorClient(api_token, sdc_url='https://', ssl_verify=False)
```
Transitioning from Python to REST
---------------------------------
If your goal is to interact with the REST API directly, you can use this Python client library to understand the REST interactions by logging the actions it takes. This is useful because full documentation of the REST API has not yet been created; and also provides a complete example of known working operations.
- Use or modify an example, or write a new script against the Python sdcclient module.
- Log the HTTP requests made by the script.
To log all the requests made by your script in significant detail, add to your script:
``` python
import logging
import http.client
http.client.HTTPConnection.debuglevel = 1
logging.basicConfig() # you need to initialize logging, otherwise you will not see anything from requests
logging.getLogger().setLevel(logging.DEBUG)
requests_log = logging.getLogger("requests.packages.urllib3")
requests_log.setLevel(logging.DEBUG)
requests_log.propagate = True
```
Then run as normal.