A simple authentication node for ForgeRock's Identity Platform 5.5 and above. This node can be configured to update a DropWizard Metrics Meter within AM which can then be read using JMX or pushed to a Graphite server.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
legal
src/main
README.md
chrome-user-agent-metric.png
example-tree.png
pom.xml

README.md

Meter Auth Tree Node

A simple authentication node for ForgeRock's Identity Platform 5.5 and above. This node can be configured to update a DropWizard Metrics Meter within AM which can then be read using JMX or pushed to a Graphite server.

Installation

Copy the .jar file from the ../target directory into the ../web-container/webapps/openam/WEB-INF/lib directory where AM is deployed. Restart the web container to pick up the new node. The node will then appear in the authentication trees components palette.

Usage

Add one or more instances of this node to an auth tree and configure the name of the metric to update by setting the "Metric Key" property.

ScreenShot

Each time this node is processed, it will increment the named metric:

ScreenShot

Enabling JMX

JMX access to AM metrics is disabled by default. To enable:

  • login to the AM console as AM administrator, and navigate to Configure > Global Services > Monitoring.
  • ensure "Monitoring Status" is enabled.
  • ensure "Monitoring RMI interface status" is enabled.

You can use tools such as jconsole (included in the Java JDK /bin directory) to connect to AM via JMX.

To Build

The code in this repository has binary dependencies that live in the ForgeRock maven repository. Maven can be configured to authenticate to this repository by following the following ForgeRock Knowledge Base Article.

Disclaimer

The sample code described herein is provided on an "as is" basis, without warranty of any kind, to the fullest extent permitted by law. ForgeRock does not warrant or guarantee the individual success developers may have in implementing the sample code on their development platforms or in production configurations.

ForgeRock does not warrant, guarantee or make any representations regarding the use, results of use, accuracy, timeliness or completeness of any data or information relating to the sample code. ForgeRock disclaims all warranties, expressed or implied, and in particular, disclaims all warranties of merchantability, and warranties related to the code, or any service or software related thereto.

ForgeRock shall not be liable for any direct, indirect or consequential damages or costs of any type arising out of any action taken by you or others related to the sample code.