Skip to content
Merged
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions docs/MONITORING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
3. [References](#3-references)


## Frontend monitoring <a name="introduction"></a>
## Frontend monitoring<a name="introduction"></a>
This section suggests an approach for using Elastic's Real User Monitoring (RUM) in order to capture user interactions with our client-side application CoMPAS-OpenSCD. The following instructions assume you/your organization already count on a hosted Elasticsearch Service deployment or an Elastic Cloud organization account with Kibana as the frontend of your monitoring stack and a URL to access it. Also it is assumed that you deploy `compas-open-scd` by using Kubernetes (and [the compas-open-scd docker public docker image](https://hub.docker.com/r/lfenergy/compas-open-scd) or your own generated image).

### 1. Getting your APM Server URL <a name="server-url"></a>
### 1. Getting your APM Server URL<a name="server-url"></a>
Navigate to your Kibana URL and select the space that you would like to associate with your frontend app (default if you don't have several spaces in Kibana). Then open the drawer menu and navigate to `APM`:

![Navigation instructions to APM in Kibana](/docs/public/kibana-screenshot-1.png)
Expand All @@ -26,7 +26,7 @@ There are two suggested code blocks for setting up the RUM Agent, find in any of

*Note: You have two options for getting your init script, you either install the `@elastic/apm-rum` dependency in your project or you set up the agent with `<script>` tags. In this document we will describe an approach for the latter.*

### 2. Using the /public/init-js script <a name="init-js"></a>
### 2. Using the /public/init-js script<a name="init-js"></a>

The __compas-open-scd__ project features a reference to an "empty" javascript resource at `index.html` (line:42)
```html
Expand Down Expand Up @@ -54,7 +54,7 @@ script.onload = function () {
document.querySelector('head').appendChild(script);
```

### 3. References <a name="references"></a>
### 3. References<a name="references"></a>

* [Full documentation about APM Real User Monitoring JavaScript Agent](https://www.elastic.co/guide/en/apm/agent/rum-js/5.x/intro.html)

Expand Down