Skip to content

Commit c42bd97

Browse files
committed
Fix package-lock and added documentation
Signed-off-by: Maia Iyer <[email protected]>
1 parent bc04a25 commit c42bd97

File tree

2 files changed

+30
-6
lines changed

2 files changed

+30
-6
lines changed

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -218,3 +218,27 @@ npm run make:deploy
218218
```
219219

220220
you will deploy all the resources located in the `manifests` folder alongside the image you selected in the previous step.
221+
222+
## Working with the MCAD exporter
223+
224+
The architecture for the MCAD dashboard requires an MCAD exporter to enable the storage of time-series appwrapper information in a Prometheus server.
225+
226+
To run the exporter locally, you can run the following command:
227+
228+
```bash
229+
npm run start:dev
230+
```
231+
232+
To build an image that exposes exported metrics, run the following make target:
233+
234+
```bash
235+
make build-exporter
236+
```
237+
238+
To run this image locally, run the following command:
239+
240+
```bash
241+
{CONTAINER_BUILDER} run -p 9101:9101 {CONTAINER_IMAGE}
242+
```
243+
244+
where `{CONTAINER_BUILDER}` is the container tool you use, set in the Makefile. This should work with podman or docker. `{EXPORTER_IMAGE_TAG}` is the tag of the exporter image. This is set in the `.env` file in the home directory of the git repo.

exporter/package-lock.json

+6-6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)