Commit 519e010c authored by M. Rehan Abbasi's avatar M. Rehan Abbasi
Browse files

fix typos in frontend-enhancements guide

parent 84f15653
Loading
Loading
Loading
Loading
+7 −7
Original line number Diff line number Diff line
@@ -22,7 +22,7 @@ For adding the new service in the [MEC API dropdown](../Sandbox-User-Interface/R

This will show the new service in the dropdown if that service is supported by the selected network scenario upon next MEC Sandbox upgrade.

To properly integrate the new servive with the MEC Sandbox front end e.g. to make the service appear in the [API console](../Sandbox-User-Interface/README.md#sbox05b), following changes in [MEC Sandbox repository](https://forge.etsi.org/rep/mec/mec-sandbox) will need to be made:
To properly integrate the new service with the MEC Sandbox frontend, e.g. to make the service appear in the [API console](../Sandbox-User-Interface/README.md#sbox05b), following changes in [MEC Sandbox repository](https://forge.etsi.org/rep/mec/mec-sandbox) will need to be made:

- `mec-sandbox/js-apps/frontend/src/js/containers/sandbox/api-table.js`
  - In the `mapService()` function, add the new service name (`meep-<mec-identifier>`) in the `prefixes` variable.
@@ -41,14 +41,14 @@ A correct MEC Service base path for the new service is also displayed in the _Tr

The 'MEC Sandbox' Grafana dashboard is provisioned using the `mec-sandbox/config/dashboards/mec-sandbox.json` file which is hosted in the [MEC Sandbox repository](https://forge.etsi.org/rep/mec/mec-sandbox).

In order to display metrics related to the new service in the dashboad, the JSON file will need to be modified. All the necessary steps that need to taken are mentioned below.
In order to display metrics related to the new service in the dashboard, the JSON file will need to be modified. All the necessary steps that need to taken are mentioned below.

> **NOTE:** Grafana will be able to fetch required metrics from Prometheus only if metrics collection is enabled for the new service. See how to enable metrics collection [here](./development-guide.md#server-side).

### 1. Add a new variable for the service in Grafana Dashboard
As a first step, add a variable for the new service that will be used in the JSON file for making target promQL queries by Grafana. This will be done by adding another array item in `templating.list`.

This variable should be assigned the same value as the 'constant' `serviceName` in `<mec-identifier>.go` file. For example, Grafana variable `mec030` for MEC030 V2X Information Service will have a value of _V2XI Service_ as is defined in the `vis.go` file for the MEC030 serivce:
This variable should be assigned the same value as the 'constant' `serviceName` in `<mec-identifier>.go` file. For example, Grafana variable `mec030` for MEC030 V2X Information Service will have a value of _V2XI Service_ as is defined in `serviceName` variable in the `vis.go` file for the MEC030 service:

```go
...
@@ -56,7 +56,7 @@ const serviceName = "V2XI Service"
...
```

Therefore, the new entry in `templating.list`, which is specific to MEC030, will look like this:
Therefore, the new entry in `templating.list`, which is (specific to MEC030 in this case), will look like this:

```JSON
{