Monitoring

The monitoring endpoint described in this section is deprecated. Use it only for diagnostics, in conjunction with Forgerock support.

A monitoring endpoint provides access to metrics for operations within the agent and between the agent an AM.

The monitoring endpoint is protected by HTTP Basic Authentication; to access it, provide the agent URL, and the AM agent profile name and password. Always use HTTPS for secure connections to client applications.

Metrics are displayed as a JSON response, with the fields described in Summary of monitoring metrics.

Access the monitoring endpoint

Install a Web Agent as described in the Installation, and use the agent to protect a web application. For example, set up the example in Policy enforcement.
Access the agent monitoring endpoint as follows, where https://agent.example.com:443 is the agent URL, and web-agent is the AM agent profile name.
```
$ curl https://agent.example.com:443/agent/monitor -u web-agent

Enter host password for user 'web-agent':
```

Enter the AM agent profile password to display the metrics:

{
  "cache-invalidation": {
    "policy": 0,
    "profile": 1
  },
  "policy-decisions": {
    "neu": 0,
    "local": 0,
    "remote": 2,
    "cache": 0
    },
  "gc": {
    "runs": 1,
    "released": 0,
    "release-deferred": 0,
    "fill": 0.000000
  },
  "cache-operations": {
    "writes": 0,
    "rewrites": 2,
    "reads": 2,
    "misses": 0,
    "deletes": 0,
    "free-deferred": 0,
    "write-faults": 0,
    "expired": 0
  },
  "connections": {
    "added": 2,
    "reused": 3
  }
}

Summary of monitoring metrics

Metric Submetric Count of

Metric	Submetric	Count of
`cache-invalidation`	`policy`	Number of policy change notifications received from AM.
`profile`	Number of agent configuration change notifications received from AM.
`policy-decisions`	`neu`	Number of requests that were not enforced by the agent because of the not-enforced URL lists.
`local`	Number of policy decisions the agent makes locally.
`remote`	Number of policy decisions the agent requests from AM.
`cache`	Number of policy decisions the agent takes from the cache.
`gc`	`runs`	Number of garbage collection runs.
`released`	Number of cache entries released during garbage collection runs.
`release-defered`	Number of entries with release deferred until the next garbage collection run.
`fill`	Floating point value between 0 and 1, representing the proportion of cache that is free after the most the recent garbage collection.
`cache-operations`	`writes`	Number of writes to cache.
`rewrites`	Number of updates to cache.
`reads`	Number of reads from cache.
`misses`	Number of failed searches of the cache.
`deletes`	Number of deletes from cache.
`free-deferred`	Number of cache removals deferred until the next garbage collection run.
`write-faults`	Number of cache writes that fail because the cache is full.
`rewrites`	Number of expired cache entries.
`connections`	`added`	Number of new connections made.
`reused`	Number of times existing connections were reused.

cache-invalidation

policy

Number of policy change notifications received from AM.

profile

Number of agent configuration change notifications received from AM.

policy-decisions

neu

Number of requests that were not enforced by the agent because of the not-enforced URL lists.

local

Number of policy decisions the agent makes locally.

remote

Number of policy decisions the agent requests from AM.

cache

Number of policy decisions the agent takes from the cache.

gc

runs

Number of garbage collection runs.

released

Number of cache entries released during garbage collection runs.

release-defered

Number of entries with release deferred until the next garbage collection run.

fill

Floating point value between 0 and 1, representing the proportion of cache that is free after the most the recent garbage collection.

cache-operations

writes

Number of writes to cache.

rewrites

Number of updates to cache.

reads

Number of reads from cache.

misses

Number of failed searches of the cache.

deletes

Number of deletes from cache.

free-deferred

Number of cache removals deferred until the next garbage collection run.

write-faults

Number of cache writes that fail because the cache is full.

rewrites

Number of expired cache entries.

connections

added

Number of new connections made.

reused

Number of times existing connections were reused.

Web Agents 2023.11.1

Monitoring

Access the monitoring endpoint

Summary of monitoring metrics