-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: Add troubleshooting section (#620)
* doc: Add troubleshooting section * doc: add FAQ about timeouts --------- Co-authored-by: Matthieu Tâche <tache.matthieu@gmail.com>
- Loading branch information
Showing
10 changed files
with
149 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| <!-- | ||
| ~ Copyright (c) 2024 Arista Networks, Inc. | ||
| ~ Use of this source code is governed by the Apache License 2.0 | ||
| ~ that can be found in the LICENSE file. | ||
| --> | ||
|
|
||
| # Troubleshooting ANTA | ||
|
|
||
| A couple of things to check when hitting an issue with ANTA: | ||
|
|
||
| ```mermaid | ||
| flowchart LR | ||
| A>Hitting an issue with ANTA] --> B{Is my issue <br >listed in the FAQ?} | ||
| B -- Yes --> C{Does the FAQ solution<<br />works for me?} | ||
| C -- Yes --> V(((Victory))) | ||
| B -->|No| E{Is my problem<br />mentioned in one<<br />of the open issues?} | ||
| C -->|No| E | ||
| E -- Yes --> F{Has the issue been<br />fixed in a newer<br />release or in main?} | ||
| F -- Yes --> U[Upgrade] | ||
| E -- No ---> H((Follow the steps below<br />and open a Github issue)) | ||
| U --> I{Did it fix<br /> your problem} | ||
| I -- Yes --> V | ||
| I -- No --> H | ||
| F -- No ----> G((Add a comment on the <br />issue indicating you<br >are hitting this and<br />describing your setup<br /> and adding your logs.)) | ||
| click B "../faq" "FAQ" | ||
| click E "https://github.com/arista-netdevops-community/anta/issues" | ||
| click H "https://github.com/arista-netdevops-community/anta/issues" | ||
| style A stroke:#f00,stroke-width:2px | ||
| ``` | ||
|
|
||
| ## Capturing logs | ||
|
|
||
| To help document the issue in Github, it is important to capture some logs so the developers can understand what is affecting your system. No logs mean that the first question asked on the issue will probably be _"Can you share some logs please?"_. | ||
|
|
||
| ANTA provides very verbose logs when using the `DEBUG` level. When using DEBUG log level with a log file, the DEBUG logging level is not sent to stdout, but only to the file. | ||
|
|
||
| !!! danger | ||
|
|
||
| On real deployments, do not use DEBUG logging level without setting a log file at the same time. | ||
|
|
||
| To save the logs to a file called `anta.log`, use the following flags: | ||
|
|
||
| ```bash | ||
| # Where ANTA_COMMAND is one of nrfu, debug, get, exec, check | ||
| anta -l DEBUG –log-file anta.log <ANTA_COMMAND> | ||
| ``` | ||
|
|
||
| See `anta --help` for more information. These have to precede the `nrfu` cmd. | ||
|
|
||
| !!! tip | ||
|
|
||
| Remember that in ANTA, each level of command has its own options and they can only be set at this level. | ||
| so the `-l` and `--log-file` MUST be between `anta` and the `ANTA_COMMAND`. | ||
| similarly, all the `nrfu` options MUST be set between the `nrfu` and the `ANTA_NRFU_SUBCOMMAND` (`json`, `text`, `table` or `tpl-report`). | ||
|
|
||
|
|
||
| As an example, for the `nrfu` command, it would look like: | ||
|
|
||
| ```bash | ||
| anta -l DEBUG --log-file anta.log nrfu --enable --username username --password arista --inventory inventory.yml -c nrfu.yml text | ||
| ``` | ||
|
|
||
|
|
||
| ### `ANTA_DEBUG` environment variable | ||
|
|
||
| ??? warning | ||
|
|
||
| Do not use this if you do not know why. This produces a lot of logs and can create confusion if you do not know what to look for. | ||
|
|
||
| The environment variable `ANTA_DEBUG=true` enable ANTA Debug Mode. | ||
|
|
||
| This flag is used by various functions in ANTA: when set to true, the function will display or log more information. In particular, when an Exception occurs in the code and this variable is set, the logging function used by ANTA is different to also produce the Python traceback for debugging. This typically needs to be done when opening a GitHub issue and an Exception is seen at runtime. | ||
|
|
||
| Example: | ||
|
|
||
| ```bash | ||
| ANTA_DEBUG=true anta -l DEBUG --log-file anta.log nrfu --enable --username username --password arista --inventory inventory.yml -c nrfu.yml text | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters