Skip to content

New operations standards based on actuator #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

New operations standards based on actuator #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
703195b
New operations standards based on actuator
dadamagouil Jan 28, 2025
f6e6aad
Same but for french version
dadamagouil Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 68 additions & 47 deletions en/operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Operations

This section covers standards linked to operations.
This section covers standards related to operations. Those standards are simply the actuator standards. Keep the actuator standards simplify the alignement of all applications in VA ecosystem.

## Environments

An API **MUST** be deployed to a QA (also called UAT) environment before being pushed to production.
An API **MUST** be deployed to a UAT environment before being pushed to production.

If more environments are required, an API developer **SHOULD** follow existing DNS naming conventions (internal link) to name environments.

Expand All @@ -18,71 +18,92 @@ The team in charge of an API running in a production environment **SHOULD** ensu

An API **SHOULD** expose an endpoint to check its health status

The parent path ```/health``` **SHOULD** provide some details about components (dependencies)

```json
{
"name": "Va.Api.Business.MyAwesomeProduct",
"status": "up",
"dependencies": [
{
"name": "Va.Api.Tech.Dependency1",
"version": null,
"depth": 1,
"status": "up"
"status": "UP",
"components": {
"discoveryComposite": {
"description": "",
"status": "UP",
"components": {
"discoveryClient": {
"description": "",
"status": "UP"
}
}
},
"livenessState": {
"status": "UP"
},
{
"name": "Va.Api.Tech.SubDependency",
"version": "4.9.0-SNAPSHOT",
"depth": 2,
"status": "up"
"readinessState": {
"status": "UP"
}
},
"groups": [
"liveness",
"readiness"
]
}

```

The path ```/health/liveness``` **SHOULD** provide the liveness
Copy link

@yrandin yrandin Jan 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could it be interesting to state the difference between liveness and readiness ?


```json
{
"status": "UP"
}

```

The path ```/health/readiness``` **SHOULD** provide the readiness

```json
{
"status": "UP"
}

```

Furthermore, continous integration tools **COULD** use the healthcheck endpoint to confirm that the API is running correctly.

### Dependencies
### Information

In non production environments, an API **SHOULD** expose an endpoint to give basic information about its run.

In non-production environments, an API **SHOULD** expose an endpoint to list Vaudoise library dependencies being used.
The path ```/info``` **SHOULD** provide following information

```json
{
"product": "Va.XCut.Back.Actuators.Core",
"version": "1.0.0.13490",
"libraries": [
{
Copy link

@yrandin yrandin Jan 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Libraries are no more included ?

"name": "Va.XCut.Api.Template.Application",
"product": "Va.XCut.Api.Template",
"version": "0.0.0.13490",
"informationalVersion": "0.0.0",
"configuration": "Debug"
},
{
"name": "Va.XCut.Back.Logger.Std",
"product": "Va.XCut.Back.Logger.Std",
"version": "1.0.0.13490",
"informationalVersion": "1.0.0-Beta01",
"configuration": "Debug"
]
"product": "vaapi-mails",
"serviceStartTime": "2025-01-27T10:23:40Z",
"buildTime": "2025-01-16T15:30:29Z",
"serviceProcessId": 1,
"version": "1.7.0-SNAPSHOT"
}

```

### Hosting
### Metrics

In non production environments, an API **SHOULD** expose an endpoint to give basic information about the hosting server.
In non production environments, an API **SHOULD** expose an endpoint to give basic information about the metrics.

The path ```/metrics``` **SHOULD** provide following information (not exhaustive list)

```json
{
"machineDomain": "VAUDOISE",
"machineName": "DEVABCDEF",
"machineOS": "Microsoft Windows 10.0.10240 ",
"machineProcessorCount": 8,
"environmentName": ".NET Core 4.6.26606.02",
"environmentArchitecture": "x64",
"serviceName": "Va.XCut.Api.Template.Application",
"serviceProcessId": 8752,
"serviceStartTime": "2018-07-05T07:29:44.4771925+02:00",
"serviceMemory": 92827648,
"serviceThreads": 21
"names": [
Copy link

@yrandin yrandin Jan 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is clearly different from before. Why this change ? It feels like this is no more the example

"application.ready.time",
"application.started.time",
"disk.free",
"disk.total",
"executor.active",
"executor.completed",
"executor.pool.core",
"executor.pool.max",
...
]
}
```
110 changes: 65 additions & 45 deletions fr/exploitation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Exploitation

Cette section couvre les standards liés à l'exploitation.
Cette section couvre les standards liés à l'exploitation. Ces normes sont simplement les normes d'actuator. Garder les normes de actuator simplifie l'alignement de toutes les applications dans l'écosystème VA.

## Environnements

Expand All @@ -16,73 +16,93 @@ L'équipe en charge d'une API utilisée en production **DEVRAIT** s'assurer qu'e

### Health check

Une API **DEVRAIT** fournir un endpoint de health check sous la forme de
Une API **DEVRAIT** fournir un endpoint de health check

L'endpoint parent ```/health``` **DEVRAIT** fournir quelques détails à propos de ses composants (dépendances) sous la forme de

```json
{
"name": "Va.Api.Business.MyAwesomeProduct",
"status": "up",
"dependencies": [
{
"name": "Va.Api.Tech.Dependency1",
"version": null,
"depth": 1,
"status": "up"
"status": "UP",
"components": {
"discoveryComposite": {
"description": "",
"status": "UP",
"components": {
"discoveryClient": {
"description": "",
"status": "UP"
}
}
},
"livenessState": {
"status": "UP"
},
{
"name": "Va.Api.Tech.SubDependency",
"version": "4.9.0-SNAPSHOT",
"depth": 2,
"status": "up"
"readinessState": {
"status": "UP"
}
},
"groups": [
"liveness",
"readiness"
]
}
```

L'endpoint ```/health/liveness``` **DEVRAIT** fournir le liveness

```json
{
"status": "UP"
}

```

L'endpoint ```/health/readiness``` **DEVRAIT** fournir le readiness

```json
{
"status": "UP"
}

```

De plus, la chaîne d'intégration continue **POURRAIT** l'utiliser afin de s'assurer que le déploiement s'est bien déroulé.

### Informations

Dans les environnements non production, une API **DEVRAIT** fournir un endpoint exposant les informations de dépendance à ses librairies Vaudoise.
Dans les environnements non production, une API **DEVRAIT** fournir un endpoint exposant les informations sur son exécution.

L'endpoint ```/info``` **DEVRAIT** fournir les informations suivantes

```json
{
"product": "Va.XCut.Back.Actuators.Core",
"version": "1.0.0.13490",
"libraries": [
{
"name": "Va.XCut.Api.Template.Application",
"product": "Va.XCut.Api.Template",
"version": "0.0.0.13490",
"informationalVersion": "0.0.0",
"configuration": "Debug"
},
{
"name": "Va.XCut.Back.Logger.Std",
"product": "Va.XCut.Back.Logger.Std",
"version": "1.0.0.13490",
"informationalVersion": "1.0.0-Beta01",
"configuration": "Debug"
]
"product": "vaapi-mails",
"serviceStartTime": "2025-01-27T10:23:40Z",
"buildTime": "2025-01-16T15:30:29Z",
"serviceProcessId": 1,
"version": "1.7.0-SNAPSHOT"
}

```

### Metriques

Dans les environnements non production, une API **DEVRAIT** fournir un endpoint exposant les unformations systeme basiques du serveur l'hébergeant.
Dans les environnements non production, une API **DEVRAIT** fournir un endpoint exposant les informations à propos de ses métriques.

L'endpoint ```/metrics``` **SHOULD** fournir les informations suivantes (liste non exhaustive)

```json
{
"machineDomain": "VAUDOISE",
"machineName": "DEVABCDEF",
"machineOS": "Microsoft Windows 10.0.10240 ",
"machineProcessorCount": 8,
"environmentName": ".NET Core 4.6.26606.02",
"environmentArchitecture": "x64",
"serviceName": "Va.XCut.Api.Template.Application",
"serviceProcessId": 8752,
"serviceStartTime": "2018-07-05T07:29:44.4771925+02:00",
"serviceMemory": 92827648,
"serviceThreads": 21
"names": [
"application.ready.time",
"application.started.time",
"disk.free",
"disk.total",
"executor.active",
"executor.completed",
"executor.pool.core",
"executor.pool.max",
...
]
}
```