https://github.com/mikaelvesavuori/slamax
Calculates maximum composite SLA for a list of sequentially provided cloud services or your custom-defined services.
https://github.com/mikaelvesavuori/slamax
cloud-sla sla sla-calculation sla-calculator
Last synced: 8 months ago
JSON representation
Calculates maximum composite SLA for a list of sequentially provided cloud services or your custom-defined services.
- Host: GitHub
- URL: https://github.com/mikaelvesavuori/slamax
- Owner: mikaelvesavuori
- License: mit
- Created: 2022-04-23T16:38:11.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-15T09:49:41.000Z (over 2 years ago)
- Last Synced: 2025-02-01T23:51:06.677Z (8 months ago)
- Topics: cloud-sla, sla, sla-calculation, sla-calculator
- Language: TypeScript
- Homepage: https://slamax.pages.dev
- Size: 517 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# `SlaMax`
**Calculates maximum composite SLA for a list of sequentially provided cloud services or your custom-defined services.**
 [](https://app.fossa.com/projects/git%2Bgithub.com%2Fmikaelvesavuori%2Fslamax?ref=badge_shield) [](https://sonarcloud.io/summary/new_code?id=mikaelvesavuori_slamax) [](https://codecov.io/gh/mikaelvesavuori/slamax) [](https://codeclimate.com/github/mikaelvesavuori/slamax/maintainability) [](https://codeclimate.com/github/mikaelvesavuori/slamax/test_coverage)
Here are a few use-cases you can use `SlaMax` for:
- Continuously calculating your system's SLA base value
- Helping teams to understand what the maximum SLO they should aim for is
- Provides an easy way for architects to understand how cloud components affect the total reliability of a solution
- Increasing overall compliance and resiliency awareness
**All SLA values are hosted in, and updated at, my other related project [`cloud-sla`](https://github.com/mikaelvesavuori/cloud-sla)**.
## 🤔 Just want to use an API rather than a library?
Use [`maxslaofmy.systems`](https://maxslaofmy.systems/) to get `SlaMax` as an API.
Use [`getsla.cloud`](https://getsla.cloud/) to retrieve SLA data via API.
## 👩🏫 Important to understand about SLAs
Since `SlaMax` has to generalize any given SLA into a number, it doesn't concern itself with any details around, for example, _what_ must be fulfilled on the customer side for the SLA to be applicable, or what exactly the SLA number refers to: All SLAs have various types of conditions that need to be fulfilled.
Also note that, especially on the Azure side, certain services don't have their own SLAs, but instead they refer back to other services and their SLAs. This is because they're not unique serices, but rather composed of other services.
## 🏗️ Installation
Run `npm install slamax` or `yarn install slamax`.
## 👩💻 Usage
An example using both an AWS service (see below for all available services and their keys) and a custom service (must start with `custom`). Custom items **must** include an `sla` key with a numeric value.
```TypeScript
import slamax from 'slamax'; // ES6+
//const slamax = require('slamax'); // ES5
const { SlaMax } = slamax;
const listOfSlas = [
{
"name": "aws-lambda"
},
{
"name": "custom-database",
"description": "Dev tier database on Heroku",
"sla": 95
}
]
const maxSla = SlaMax(listOfSlas);
console.log(`The maximum composite SLA is ${maxSla}%`);
```
## 📊 Diagram
