ObservabilityAPI 1.0.4

ObservabilityAPI

ObservabilityAPI

Observability API

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.2
• Package version: 1.0.2
• Generator version: 7.11.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import ObservabilityAPI

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import ObservabilityAPI

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import ObservabilityAPI
from ObservabilityAPI.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost/PhrameObservability
# See configuration.py for a list of all supported configuration parameters.
configuration = ObservabilityAPI.Configuration(
    host = "http://localhost/PhrameObservability"
)



# Enter a context with an instance of the API client
with ObservabilityAPI.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ObservabilityAPI.GrafanaApi(api_client)
    datasource_name = 'datasource_name_example' # str | Name for the datasource
    datasource_type = prometheus # str | Type of datasource to create (default to prometheus)
    datasource_url = 'datasource_url_example' # str | URL of the datasource endpoint
    service_key = 'service_key_example' # str | Grafana service account key for authentication
    database_name = 'database_name_example' # str | Database name (for database datasources) (optional)
    username = 'username_example' # str | Username for datasource authentication (optional)
    password = 'password_example' # str | Password for datasource authentication (optional)
    is_default = False # bool | Set this datasource as default (optional) (default to False)
    basic_auth = False # bool | Enable basic authentication (optional) (default to False)

    try:
        # Add Datasource to Grafana
        api_response = api_instance.add_grafana_datasource(datasource_name, datasource_type, datasource_url, service_key, database_name=database_name, username=username, password=password, is_default=is_default, basic_auth=basic_auth)
        print("The response of GrafanaApi->add_grafana_datasource:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling GrafanaApi->add_grafana_datasource: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost/PhrameObservability

Class	Method	HTTP request	Description
GrafanaApi	add_grafana_datasource	POST /grafana/datasource	Add Datasource to Grafana
GrafanaApi	deploy_grafana_dashboards	GET /grafana	Deploy Grafana Dashboards
GrafanaApi	generate_grafana_service_key	GET /grafana/auth	Generate Grafana Service Account Key
PrometheusApi	add_exporter_to_host	PUT /prometheus	Add/Update Specific Exporter for Host
PrometheusApi	add_prometheus_target	POST /prometheus	Add Prometheus Monitoring Target
PrometheusApi	get_prometheus_targets	GET /prometheus	Get Prometheus Targets Configuration
PrometheusApi	remove_prometheus_target	DELETE /prometheus	Remove Prometheus Monitoring Target

Documentation For Models

• AddExporterToHost200Response
• AddExporterToHost200ResponseExporter
• AddGrafanaDatasource200Response
• AddPrometheusTarget200Response
• DbPhrameJSONStore
• DeployGrafanaDashboards200Response
• GenerateGrafanaServiceKey200Response
• GetPrometheusTargets200Response
• GetPrometheusTargets200ResponseTargetsInner
• GetPrometheusTargets200ResponseTargetsInnerPorts
• RemovePrometheusTarget200Response

Documentation For Authorization

Endpoints do not require authorization.

Author

[e-mail]