Page History

Scroll Ignore

scroll-pdf	true
scroll-office	true
scroll-chm	true
scroll-docbook	true
scroll-eclipsehelp	true
scroll-epub	true
scroll-html	true

Panel

title	Sommaire

Table of Contents

style	none

Objectifs

Info

title	Pré-requis

Le module livedata-module-sla-provider doit être activé sur le broker-module-livedata pour que la route /api/v1/sla/ soit accessible.

La configuration du module se trouve par défaut dans le fichier suivant : /etc/shinken/modules/livedata-module-sla-provider.cfg : Le livedata-module-sla-provider

Méthode POST de type READ qui permet de recevoir la liste des données SLA de tous les éléments ( hôtes, clusters et checks ) :

Filtrées ( optionnel ),
Rangées,
- En arbres ( hôtes/clusters → checks ),
- Tous au même niveau,
- Seulement les données SLA des éléments demandés.
En choisissant,
- les informations présentes dans le retour de la requête ( optionnel ),
- la période sur laquelle les données SLA seront récupérées ( optionnel ),
  - les données SLA sont calculées à la fin de la journée, donc la dernière donnée disponible est celle de la veille,
- le nombre d'éléments par page ( optionnel ).
Les données SLA récupérées sont triées dans l'ordre chronologie ( du plus récent au plus vieux ).

Paramètres

Pour définir l'appel, 5 paramètres sont disponibles :

standards :
- filterX
- output_format
- ouput_field
- period
- page_settings

filterX ( Filtres )
Anchor
filterX
filterX

Les filtres ont pour formes :

filterX = expression~expression
- ~ ayant le sens de "et"
- expression de la forme : critère:valeur0^^valeur1
  - où ^^ a le sens de "ou"
X vaut de 0 à 9.
Chaque élément correspondant à au moins un des filtres sera retourné.

Les critères suivants sont utilisables :

type
father_name
father_uuid
father_templates
check_name
check_uuid
address
realm
host_groups
notification_contacts
notification_contact_groups
business_impact

Vous pouvez trouver la description de ces filtres dans la page V1 - Les paramètres de l'API du module livedata-module-sla-provider du broker-module-livedata

output_format ( Format de retour de la requête )

Ce paramètre permet d'indiquer où sont situés les checks dans la réponse de retour :

checks_attached_to_father : les checks sont accrochés à leurs hôtes / clusters ( forme d'arbre )
elements_on_same_level : les checks sont listés au niveau des hôtes / clusters ( une liste )
list_of_sla : Seul les données SLA sont listées ( une liste )

REMARQUE : Dans le cas ou le filtre vaut uniquement type=check ( donc pas d'hôtes ou clusters )

Si le output_format = checks_attached_to_father , les hôtes / clusters seront quand même présents pour les checks correspondant à ce filtre.
Si le output_format = elements_on_same_level ou output_format = list_of_sla, les hôtes et clusters ne sont pas présents.

Info
Par défaut, la valeur est "elements_on_same_level"

output_field ( Informations présentes dans le retour de la requête )
Anchor
outputField
outputField

Ce paramètre permet de lister les champs qui seront affichés sur le résultat en sortie.

Les champs présents par défaut sont :
- father_name
- father_uuid
- check_name
- check_uuid

Les champs pouvant être ajoutés par l'utilisateur
- type

Info
Le champ type fait partie des champs présents par défaut pour les formats de retour "elements_on_same_level" et "list_of_sla".

Info
Les champs ci-dessus sont décrits dans la page V1 - Les paramètres de l'API du module livedata-module-sla-provider du broker-module-livedata

Les champs suivants sont propres à cette route et sont présent par défaut :

Nom	Format	Description
sla_total	Secondes	Temps total de SLA ( 86400 secondes étant 1 journée complète )
sla_missing	Secondes	Temps en statut Données manquantes
sla_ok	Secondes	Temps en statut OK
sla_inactive	Secondes	Temps en statut Shinken Inactive
sla_unknown	Secondes	Temps en statut Inconnu
sla_crit	Secondes	Temps en statut Critique
sla_warn	Secondes	Temps en statut Attention
sla_thresholds	Liste de pourcentages	Deux pourcentages : la première valeur est le seuil d'avertissement la deuxième valeur est le seuil de critique Les pourcentages ont une précision à 3 chiffres ( ex: 90.001 )
sla_date	Chaîne de caractères	au format jj_mm_aaaa ( ex: 12_05_2021 )

Exemple :

Code Block

language	js
theme	Confluence

{
    "sla_date": "25_05_2021",
    "sla_total": 86400,
    "sla_warn": 0,
    "sla_unknown": 0,
    "sla_thresholds": [58.654, 32.451],
    "sla_missing": 292,
    "sla_ok": 27834,
    "sla_inactive": 58274,
    "sla_crit": 0
}

period ( entre quelles dates de début et de fin, prendre les données SLA )

Nom

Valeur par défaut

Description et syntaxe

period=start:date~end:date

La date de la veille

Défini la période où collecter les données SLA

Les dates sont au format jj_mm_aaaa ( ex: 12_05_2021 )
Si start n'est pas précisé, cela signifie que le début de la période est la date de la veille.
Si end n'est pas précisé, la fin de la période est égal à la date de début.

Trois règles devront être respectées :

La date de départ ne peut pas être antérieur à la date de la première donnée SLA disponible.
La date de départ ne peut pas être supérieur à la date de la veille.
La date de fin ne peut pas être supérieur à la date de début.

Warning

Si une de ces trois règles n'est pas respectée, un de ces trois messages d'erreur apparaîtra indiquant à l'utilisateur son erreur :

Cette erreur indique que l'utilisateur a saisi une date de début inférieure à la date de la plus ancienne donnée SLA enregistrer dans la base MongoDB
Panel
borderColor #dfe1e5
borderWidth 1
borderStyle solid
ERROR 400: period: the start period is not valid, as there is no SLA data for this date. You can filter elements from 13_02_2021.
Cette erreur indique que l'utilisateur a saisi une date de fin supérieur à la date de la veille
Panel
borderColor #dfe1e5
borderWidth 1
borderStyle solid
ERROR 400: period: the end period is invalid, as the requested period is in the future. You can filter elements until 24_05_2021.
Cette erreur indique que l'utilisateur a saisi une date de fin inférieur à la date de début saisie
Panel
borderColor #dfe1e5
borderWidth 1
borderStyle solid
ERROR 400: period: the end period is invalid, as it's less than the start period.

page_settings ( combien d’éléments par page et quelle page retourner )

L'API peut, grâce à ce paramètre, définir le nombre d'éléments par page et le numéro de la page retournée, ce qui permet de contrôler le volume d'échange de données. Ceci est possible vu que les données SLA sont figées en base de données.

Le champ has_next_page dans la partie pagination du retour permet de savoir s’il y a une page suivante.

Nom	Valeur par défaut	Info
page_settings=page:page_index~nb_element:size	Le nombre d'éléments par défaut d'une page est 100	nb_element étant la taille de la page page étant l'index de page demandée. Les indexes de page commencent à 0

Info

Si output_format est à checks_attached_to_father , le nombre d'éléments par page correspondra aux hôtes / clusters.

Si output_format est à elements_on_same_level , le nombre d'éléments par page correspondra aux hôtes / clusters / checks.

Si output_format est à list_of_sla, le nombre d'éléments par page correspondra aux données SLA des hôtes / clusters / checks.

Exemple

Exemple permettant d'obtenir la première page d'une requête renvoyant 100 éléments avec leurs données SLA, du début de l'année 2021 au 1er mai 2021.

Code Block

language	bash
theme	Emacs

curl -s -S -H "x-api-token: XYZ" \
 -d "period=start:01_01_2021~end:01_05_2021" \
 -d "page_settings=page:0~nb_element:100" \
http://broker-module-livedata:50100/api/v1/sla

Exemple permettant d'obtenir la quatrième page d'une requête renvoyant 100 éléments avec leurs données SLA, du début de l'année 2021 au 1er mai 2021.

Code Block

language	bash
theme	Emacs

curl -s -S -H "x-api-token: XYZ" \
 -d "period=start:01_01_2021~end:01_05_2021" \
 -d "page_settings=page:4~nb_element:100" \
http://broker-module-livedata:50100/api/v1/sla

Réponse

Codes de retour

Codes de retour	Explications
200	OK
400	Paramètre invalide
401	Accès nécessite une authentification ou un Token valide.
403	Authentification de l'utilisateur OK, mais droits non suffisants.
500	L'appel est valide, mais un problème d'exécution est survenu.

Retour du code 200

En premier apparaîtra des informations donnant le nombre d'éléments :

request_statistics
- nb_elements_total
- nb_hosts_total
- nb_clusters_total
- nb_checks_total
- nb_elements_filtered
- nb_hosts_filtered
- nb_clusters_filtered
- nb_checks_filtered
- nb_elements_in_page
- nb_hosts_in_page
- nb_clusters_in_page
- nb_checks_in_page

Avec une information supplémentaire propre à la route :

Nom	Format	Description
nb_sla_in_page	Entier	Nombre de données SLA présentes dans la page

En deuxième, les données de pagination vont être retournées dans le format suivant :

pagination
- has_next_page
- nb_total_page
- page
- page_size

Les champs présents pour chaque élément retourné possédant des données SLA doivent être choisis avec l'option output_field, mais les champs suivants sont au minimum automatiquement retournés :

Output_format à checks_attached_to_father :

elements_found
- hosts
  - father_name
  - father_uuid
  - checks
    - check_name
    - check_uuid
    - sla
      - sla_total
      - sla_missing
      - sla_ok
      - sla_inactive
      - sla_unknown
      - sla_crit
      - sla_warn
      - sla_thresholds
      - sla_date
- clusters
  - father_name
  - father_uuid
  - checks
    - check_name
    - check_uuid
    - sla
      - sla_total
      - sla_missing
      - sla_ok
      - sla_inactive
      - sla_unknown
      - sla_crit
      - sla_warn
      - sla_thresholds
      - sla_date
elements_not_found

Output_format à elements_on_same_level :

elements_found
- type
- father_name
- father_uuid
- check_name
- check_uuid
- sla
  - sla_total
  - sla_missing
  - sla_ok
  - sla_inactive
  - sla_unknown
  - sla_crit
  - sla_warn
  - sla_thresholds
  - sla_date
elements_not_found

Output_format à list_of_sla :

elements_found
- type
- father_name
- father_uuid
- check_name
- check_uuid
- sla_total
- sla_missing
- sla_ok
- sla_inactive
- sla_unknown
- sla_crit
- sla_warn
- sla_thresholds
- sla_date
elements_not_found

Voir la page V1 - Les champs présents dans le retour 200 des API du broker-module-livedata, pour la description complète de tous les champs pouvant être renvoyés. Pour les éléments non trouvés, les critères utilisés dans les filtres seront renvoyés dans la description des l'élément.

Exemple 1 : output_format=checks_attached_to_father

Code Block

language	bash
theme	Emacs

curl -s -S -H "x-api-token: XYZ" \
 -d "period=start:24_05_2021~end:25_05_2021" \
 -d "output_format=checks_attached_to_father" \ 
 -d "filter01=type:check" \
 -d "page_settings=page:0~size:2" \
http://broker-module-livedata:50100/api/v1/sla

Code Block

{
    "request_statistics": {
        "nb_elements_total": 34,
        "nb_hosts_total": 3,
        "nb_clusters_total": 1,
        "nb_checks_total": 30,
        "nb_elements_filtered": 4,
        "nb_hosts_filtered": 1,
        "nb_clusters_filtered": 1,
        "nb_checks_filtered": 2,
        "nb_elements_in_page": 4,
        "nb_hosts_in_page": 1,
        "nb_clusters_in_page": 1,
        "nb_checks_in_page": 2,
        "nb_sla_in_page": 4
    },
    "pagination": {
        "has_next_page": true,
        "nb_total_page": 2,
        "page": 0,
        "page_size": 2
    },
    "elements_found": {
        "clusters": [{
                "father_uuid": "12760f56bc6d11eb85a3080027c44e8f",
                "father_name": "Cluster 01",
                "checks": [{
                        "check_name": "Check Cluster 01",
                        "check_uuid": "12760f56bc6d11eb85a3080027c44e8f-9d86c522bd3511ebb58c080027c44e8f",
                        "sla": [{
                                "sla_date": "24_05_2021",
                                "sla_total": 86400,
                                "sla_warn": 0,
                                "sla_unknown": 0,
                                "sla_thresholds": [99.0, 97.0],
                                "sla_missing": 0,
                                "sla_ok": 0,
                                "sla_inactive": 86400,
                                "sla_crit": 0
                            }, {
                                "sla_date": "25_05_2021",
                                "sla_total": 47616,
                                "sla_warn": 0,
                                "sla_unknown": 0,
                                "sla_thresholds": [99.0, 97.0],
                                "sla_missing": 0,
                                "sla_ok": 0,
                                "sla_inactive": 47616,
                                "sla_crit": 0
                            }
                        ]
                    }
                ]
            }
        ],
        "hosts": [{
                "father_uuid": "f87c2e56b94b11ebaf7e080027c44e8f",
                "father_name": "Host 01",
                "checks": [{
                        "check_name": "Check 01",
                        "check_uuid": "f87c2e56b94b11ebaf7e080027c44e8f-fdd0c038b94b11ebb21f080027c44e8f",
                        "sla": [{
                                "sla_date": "24_05_2021",
                                "sla_total": 86400,
                                "sla_warn": 0,
                                "sla_unknown": 0,
                                "sla_thresholds": [99.0, 97.0],
                                "sla_missing": 0,
                                "sla_ok": 0,
                                "sla_inactive": 86400,
                                "sla_crit": 0
                            }, {
                                "sla_date": "25_05_2021",
                                "sla_total": 86400,
                                "sla_warn": 0,
                                "sla_unknown": 0,
                                "sla_thresholds": [99.0, 97.0],
                                "sla_missing": 0,
                                "sla_ok": 0,
                                "sla_inactive": 86400,
                                "sla_crit": 0
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

Exemple 2 : output_format=elements_on_same_level

Code Block

language	bash
theme	Emacs

curl -s -S -H "x-api-token: XYZ" \
-d "period=start:24_05_2021~end:25_05_2021" \
-d "output_format=elements_on_same_level" \
-d "filter01=type:check" \
-d "page_settings=page:0~size:2" \
http://broker-module-livedata:50100/api/v1/sla

Code Block

{
    "request_statistics": {
        "nb_elements_total": 34,
        "nb_hosts_total": 3,
        "nb_clusters_total": 1,
        "nb_checks_total": 30,
        "nb_elements_filtered": 30,
        "nb_hosts_filtered": 0,
        "nb_clusters_filtered": 0,
        "nb_checks_filtered": 30,
        "nb_elements_in_page": 2,
        "nb_hosts_in_page": 0,
        "nb_clusters_in_page": 0,
        "nb_checks_in_page": 2,
        "nb_sla_in_page": 4
    },
    "pagination": {
        "has_next_page": true,
        "nb_total_page": 15,
        "page": 0,
        "page_size": 2
    },
    "elements_found": [{
            "check_name": "Check Cluster 01",
            "type": "check_cluster",
            "father_uuid": "12760f56bc6d11eb85a3080027c44e8f",
            "father_name": "Cluster 01",
            "check_uuid": "12760f56bc6d11eb85a3080027c44e8f-9d86c522bd3511ebb58c080027c44e8f",
            "sla": [{
                    "sla_date": "24_05_2021",
                    "sla_total": 86400,
                    "sla_warn": 0,
                    "sla_unknown": 0,
                    "sla_thresholds": [99.0, 97.0],
                    "sla_missing": 0,
                    "sla_ok": 0,
                    "sla_inactive": 86400,
                    "sla_crit": 0
                }, {
                    "sla_date": "25_05_2021",
                    "sla_total": 51527,
                    "sla_warn": 0,
                    "sla_unknown": 24183,
                    "sla_thresholds": [99.0, 97.0],
                    "sla_missing": 3916,
                    "sla_ok": 0,
                    "sla_inactive": 23428,
                    "sla_crit": 0
                }
            ]
        }, {
            "check_name": "Check 01",
            "type": "check_host",
            "father_uuid": "f87c2e56b94b11ebaf7e080027c44e8f",
            "father_name": "Host 01",
            "check_uuid": "f87c2e56b94b11ebaf7e080027c44e8f-fdd0c038b94b11ebb21f080027c44e8f",
            "sla": [{
                    "sla_date": "24_05_2021",
                    "sla_total": 86400,
                    "sla_warn": 0,
                    "sla_unknown": 0,
                    "sla_thresholds": [99.0, 97.0],
                    "sla_missing": 165,
                    "sla_ok": 27344,
                    "sla_inactive": 58891,
                    "sla_crit": 0
                }, {
                    "sla_date": "25_05_2021",
                    "sla_total": 86400,
                    "sla_warn": 0,
                    "sla_unknown": 0,
                    "sla_thresholds": [58.654, 32.451],
                    "sla_missing": 245,
                    "sla_ok": 27881,
                    "sla_inactive": 58274,
                    "sla_crit": 0
                }
            ]
        }
    ]
}

Exemple 3 : output_format=list_of_sla

Code Block

language	bash
theme	Emacs

curl -s -S -H "x-api-token: XYZ" \
-d "period=start:24_05_2021~end:25_05_2021" \
-d "output_format=list_of_sla" \
-d "filter01=type:check" \
-d "page_settings=page:0~size:2" \
http://broker-module-livedata:50100/api/v1/sla

Code Block

{
    "request_statistics": {
        "nb_elements_total": 34,
        "nb_hosts_total": 3,
        "nb_clusters_total": 1,
        "nb_checks_total": 30,
        "nb_elements_filtered": 30,
        "nb_hosts_filtered": 0,
        "nb_clusters_filtered": 0,
        "nb_checks_filtered": 30,
        "nb_elements_in_page": 1,
        "nb_hosts_in_page": 0,
        "nb_clusters_in_page": 0,
        "nb_checks_in_page": 1,
        "nb_sla_in_page": 2
    },
    "pagination": {
        "has_next_page": "true",
        "nb_total_page": 30,
        "page": 0,
        "page_size": 2
    },
    "elements_found": [{
            "sla_total": 86400,
            "sla_thresholds": [99.0, 97.0],
            "check_name": "Check Cluster 01",
            "check_uuid": "12760f56bc6d11eb85a3080027c44e8f-9d86c522bd3511ebb58c080027c44e8f",
            "father_uuid": "12760f56bc6d11eb85a3080027c44e8f",
            "sla_ok": 0,
            "sla_inactive": 86400,
            "sla_warn": 0,
            "sla_date": "24_05_2021",
            "father_name": "Cluster 01",
            "sla_unknown": 0,
            "sla_missing": 0,
            "type": "check_cluster",
            "sla_crit": 0
        }, {
            "sla_total": 51527,
            "sla_thresholds": [99.0, 97.0],
            "check_name": "Check Cluster 01",
            "type": "check_cluster",
            "father_uuid": "12760f56bc6d11eb85a3080027c44e8f",
            "sla_ok": 0,
            "sla_inactive": 23428,
            "sla_crit": 0,
            "sla_date": "25_05_2021",
            "father_name": "Cluster 01",
            "sla_unknown": 24183,
            "sla_missing": 3916,
            "check_uuid": "12760f56bc6d11eb85a3080027c44e8f-9d86c522bd3511ebb58c080027c44e8f",
            "sla_warn": 0
        }
    ]
}

Retour du code 400

Paramètres POST incorrects

Paramètre inconnu

Code Block

language	bash
theme	Emacs

curl -s -S -H "x-api-token: XYZ" \
-d "parametre_inconnu=is_status_:true" \ 
http://broker-module-livedata:50100/api/v1/sla

Panel

borderColor	#dfe1e5
borderWidth	1
borderStyle	solid

ERROR 400: POST parameter [ parametre_inconnu ] is unknown

Messages d'erreurs des filtres ( HIDDEN - 001.0 __ V1 - ( READ ) /api/v1/sla/ -- OPTIONNEL -- )

Filtre inexistant

Code Block

language	bash
theme	Emacs

curl -s -S -H "x-api-token: XYZ" \
-d "filter01=is_status_:true" \
http://broker-module-livedata:50100/api/v1/sla

Panel

borderColor	#dfe1e5
borderWidth	1
borderStyle	solid

ERROR 400: filtering[0]: invalid field name [is_status_]

Filtre incomplet

Code Block

language	bash
theme	Emacs

curl -s -S -H "x-api-token: XYZ" \
-d "filter0=next_check" \ 
http://broker-module-livedata:50100/api/v1/sla

Panel

borderColor	#dfe1e5
borderWidth	1
borderStyle	solid

ERROR 400: filtering[0]: missing value for field [ next_check ]

Filtre existant, mais non autorisé

Code Block

language	bash
theme	Emacs

curl -s -S -H "x-api-token: XYZ" \
-d "filter01=is_status_confirmed:true" \
http://broker-module-livedata:50100/api/v1/sla

Panel

borderColor	#dfe1e5
borderWidth	1
borderStyle	solid

ERROR 400: filtering[0]: field name [is_status_confirmed] not allowed in this route

Valeur incorrecte pour ce type de filtre

Code Block

language	bash
theme	Emacs

curl -s -S -H "x-api-token: XYZ" \
-d "filter0=business_impact:cinq" \ 
http://broker-module-livedata:50100/api/v1/sla

Panel

borderColor	#dfe1e5
borderWidth	1
borderStyle	solid

ERROR 400: filtering[0]: field [ business_impact ] => wrong value [u'cinq']

Messages d'erreurs des champs présents dans la sortie ( output_field )

Champ de sortie existant, mais non autorisé

Code Block

language	bash
theme	Emacs

curl -s -S -H "x-api-token: XYZ" \
-d "output_field=is_status_confirmed" \
http://broker-module-livedata:50100/api/v1/sla

Panel

borderColor	#dfe1e5
borderWidth	1
borderStyle	solid

ERROR 400: output_field: field name [is_status_confirmed] not allowed in this route

Champ de sortie inexistant

Code Block

language	bash
theme	Emacs

curl -s -S -H "x-api-token: XYZ" \
-d "output_field=is_status_" \
http://broker-module-livedata:50100/api/v1/sla

Panel

borderColor	#dfe1e5
borderWidth	1
borderStyle	solid

ERROR 400: output_field: invalid field name [is_status_]

Page tree

Versions Compared

Old Version 82

New Version 83

Key

Objectifs

Paramètres

filterX ( Filtres )
Anchor
filterX
filterX

output_format ( Format de retour de la requête )

output_field ( Informations présentes dans le retour de la requête )
Anchor
outputField
outputField

period ( entre quelles dates de début et de fin, prendre les données SLA )

page_settings ( combien d’éléments par page et quelle page retourner )

Exemple

Réponse

Codes de retour

Retour du code 200

Exemple 1 : output_format=checks_attached_to_father

Exemple 2 : output_format=elements_on_same_level

Exemple 3 : output_format=list_of_sla

Retour du code 400

Paramètres POST incorrects

Paramètre inconnu

Messages d'erreurs des filtres ( HIDDEN - 001.0 __ V1 - ( READ ) /api/v1/sla/ -- OPTIONNEL -- )

Filtre inexistant

Filtre incomplet

Filtre existant, mais non autorisé

Valeur incorrecte pour ce type de filtre

Messages d'erreurs des champs présents dans la sortie ( output_field )

Champ de sortie existant, mais non autorisé

Champ de sortie inexistant

Page tree

Page History

Versions Compared

Old Version 82

New Version 83

Key

Objectifs

Paramètres

filterX ( Filtres ) AnchorfilterXfilterX

output_format ( Format de retour de la requête )

output_field ( Informations présentes dans le retour de la requête ) AnchoroutputFieldoutputField

period ( entre quelles dates de début et de fin, prendre les données SLA )

page_settings ( combien d’éléments par page et quelle page retourner )

Exemple

Réponse

Codes de retour

Retour du code 200

Exemple 1 : output_format=checks_attached_to_father

Exemple 2 : output_format=elements_on_same_level

Exemple 3 : output_format=list_of_sla

Retour du code 400

Paramètres POST incorrects

Paramètre inconnu

Messages d'erreurs des filtres ( HIDDEN - 001.0 __ V1 - ( READ ) /api/v1/sla/ -- OPTIONNEL -- )

Filtre inexistant

Filtre incomplet

Filtre existant, mais non autorisé

Valeur incorrecte pour ce type de filtre

Messages d'erreurs des champs présents dans la sortie ( output_field )

Champ de sortie existant, mais non autorisé

Champ de sortie inexistant

filterX ( Filtres )
Anchor
filterX
filterX

output_field ( Informations présentes dans le retour de la requête )
Anchor
outputField
outputField