Skip to main content

Generate OpenSLO and Nobl9 yaml configuration

Project description

slo-yaml-generator

:bangbang: This project is under development and subject to change. :bangbang:

Quickly generate OpenSLO and Nobl9 yaml so I can stop going and looking at the doc.

Usage

  1. Clone the repo.
  2. Install dependencies to your virtual env with:
    pip install -r requirements.txt
    

The script takes a json file containing the fields needed for each template.

Files are currently sent to the ./output/ directory. I plan to add an option to configure this soon.

Example:

python3 main.py --resource_type slo --config_file "example-configs/cloudwatch-slo.json"

Config Files

SLO

{
  "resource_name": "My Demo SLO",
  "service_name": "Service Name",
  "project_name": "Project Name",
  "sli_name": "test indicator",
  "metric_source": "Dynatrace",
  "operation": "lt",
  "value": "100",
  "target": ".99",
  "duration": "28d",
  "is_rolling": "True",
  "budgeting_method": "Occurrences"
}

For metric_source Cloudwatch please include these fields:

{
  "region": "us-east-1",
  "aws_service": "AWS/Lambda",
  "metric_name": "Errors",
  "statistic": "Sum"
}

For metric_source Dynatrace please include these fields:

{
  "query": "dynatrace query"
}

Service

{
  "resource_name": "This is a test service",
  "project_name": "Jack's Project",
  "description": "This is a test description for Jack's little tool for SLO consulting"
}

Project (Nobl9 format only)

{
  "resource_name": "This is a test project",
  "description": "This is a test description for Jack's little tool for SLO consulting"
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

slo_yaml_generator-0.0.1.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

slo_yaml_generator-0.0.1-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file slo_yaml_generator-0.0.1.tar.gz.

File metadata

  • Download URL: slo_yaml_generator-0.0.1.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.4

File hashes

Hashes for slo_yaml_generator-0.0.1.tar.gz
Algorithm Hash digest
SHA256 a0a8d4856a0903473d5956c35b59961b6667b071026cb08cf22a7b75c685b149
MD5 07cca143caa92148176db6417e7fdeba
BLAKE2b-256 49d732bb050722ffca518384ebc2ef147303e144345fccffa50222ee94932638

See more details on using hashes here.

File details

Details for the file slo_yaml_generator-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for slo_yaml_generator-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5c52095a81bb8a1bab00804c7c347a146ca8b837456fe3c9f5a3f0d036b6da91
MD5 e68f491ba2bf1dbaaa2ea006033c420b
BLAKE2b-256 d67c9fa96d960f6ffef774ab453bea5ea775f4e3b3284685de1a6d3cd45de6da

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page