almet/argos
1
0
Fork 0
mirror of https://framagit.org/framasoft/framaspace/argos.git synced 2025-04-28 18:02:41 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Change mermaid class diagrams

Browse source
This commit is contained in:
Alexis Métaireau 2023-10-20 01:25:17 +02:00
parent 336c4e783b
commit 0adb5e2766
4 changed files with 27 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
docs/capture.png
View file

Binary file not shown.
Side by side Swipe Overlay

Before

Width:  |  Height:  |  Size: 138 KiB

After

Width:  |  Height:  |  Size: 300 KiB

42
docs/developer/models.md
View file

@ -3,26 +3,28 @@
```{mermaid} ```{mermaid}
classDiagram classDiagram
direction RL direction RL
Task *-- Result : Have many class Task {
Task: id - url
Task: url - domain
Task: domain - check
Task: check - expected
Task: expected - frequency
Task: frequency - selected_by
Task: selected_by - selected_at
Task: selected_at - completed_at
Task: completed_at - next_run
Task: next_run }
class Result{
Result: id - task : Task
Result: task_id - task_id
Result: task - task
Result: agent_id - agent_id
Result: submitted_at - submitted_at
Result: status - status
Result: severity - severity
Result: context - context
}
Result "*" o-- "1" Task : has many
``` ```

7
docs/index.md
View file

@ -1,4 +1,4 @@
# Argos # Argos monitoring
Argos is an HTTP monitoring service. Argos is an HTTP monitoring service.
@ -15,6 +15,9 @@ Internally, a HTTP API is exposed, and a job queue is used to distribute the che
- **Extensible**: You can add new checks using pure python. - **Extensible**: You can add new checks using pure python.
- **HTTP API**: You can use the HTTP API to get the results of the checks. - **HTTP API**: You can use the HTTP API to get the results of the checks.
![Argos architecture](capture.png)
## Installation
```{code-block} bash ```{code-block} bash
pip install argos-monitoring pip install argos-monitoring
argos server run argos server run
@ -35,7 +38,7 @@ caption: config.yaml
The best way to get started with argos. The best way to get started with argos.
::: :::
:::{grid-item-card} Developper docs :::{grid-item-card} Developper docs
:link: /developper :link: /developer/overview.html
You want to know more about the internals ?. You want to know more about the internals ?.
::: :::
:::: ::::

35
docs/make.bat
View file

@ -1,35 +0,0 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
exit /b 1
)
if "%1" == "" goto help
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd