Skip to content
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

Update src/README.md for Network Dashboard #1060

Merged
merged 5 commits into from
Dec 21, 2022
Merged

Update src/README.md for Network Dashboard #1060

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
093f390
Update src/README.md for Network Dashboard
aurelienlegrand Dec 20, 2022
7bd4b69
Update README.md
aurelienlegrand Dec 20, 2022
f3b6ac4
Update README.md
aurelienlegrand Dec 20, 2022
23c5d18
Update README.md
aurelienlegrand Dec 20, 2022
9af72b8
Merge branch 'master' into aurelienlegrand-net-dash-1
ludoo Dec 21, 2022
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
35 changes: 20 additions & 15 deletions blueprints/cloud-operations/network-dashboard/src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,21 +18,21 @@ Usage: main.py [OPTIONS]
CLI entry point.

Options:
-dr, --discovery-root TEXT Root node for asset discovery,
organizations/nnn or folders/nnn. [required]
-op, --monitoring-project TEXT GCP monitoring project where metrics will be
stored. [required]
-p, --project TEXT GCP project id, can be specified multiple
times.
-f, --folder INTEGER GCP folder id, can be specified multiple
times.
--custom-quota-file FILENAME Custom quota file in yaml format.
--dump-file FILENAME Export JSON representation of resources to
file.
--load-file FILENAME Load JSON resources from file, skips init and
discovery.
--debug-plugin TEXT Run only core and specified timeseries plugin.
--help Show this message and exit.
-dr, --discovery-root TEXT Root node for asset discovery,
organizations/nnn or folders/nnn. [required]
-mon, --monitoring-project TEXT GCP monitoring project where metrics will be
stored. [required]
-p, --project TEXT GCP project id to be monitored, can be specified multiple
times.
-f, --folder INTEGER GCP folder id to be monitored, can be specified multiple
times.
--custom-quota-file FILENAME Custom quota file in yaml format.
--dump-file FILENAME Export JSON representation of resources to
file.
--load-file FILENAME Load JSON resources from file, skips init and
discovery.
--debug-plugin TEXT Run only core and specified timeseries plugin.
--help Show this message and exit.
```

In normal use three pieces of information need to be passed in:
Expand Down Expand Up @@ -75,6 +75,11 @@ The main module cycles through stages, calling stage plugins in succession itera

## Debugging and Troubleshooting

Note that python version > 3.8 is required.

If you run into a `ModuleNotFoundError`, install the required dependencies:
`pip3 install -r requirements.txt`

A few convenience options are provided to simplify development, debugging and troubleshooting:

- the discovery phase results can be dumped to a JSON file, that can then be used to check actual resource representation, or skip the discovery phase entirely to speed up development of timeseries-related functions
Expand Down