"1"
Open Access
The end of life (EOL) date for this module is on 31 January, 2020.
API
| Command List | Gateway API commands allow for a myriad of actions to be performed, from accepting FKM triggers or SNMP traps, to snoozing problematic items. | |
| Connect | This user guide talks through how to connect your Open Access client. | |
| DataSets | The DataSet is the first port of call to access data from Gateway instances. | |
| DataView | The DataView is a table of changing cells, each having various items of metadata such as severity or snoozed status. | |
| Executing Commands | This user guide provides a real world example of snoozing a problematic item. | |
| Knowledge Base Commands | Gateway Knowledge Base support is also provided as part of the commands API. |
Client
| Client Logging | The Open Access API client jar has been written to log using SLF4J. It can integrate with existing logging in your code or use Logback. | |
| Network Settings | The Open Access Client will always try to detect an external IP address that cluster nodes can use to communicate with the client. | |
| Scripting | Geneos features a simple scripting engine for use with Open Access. It uses the Scala programming language. | |
| SSL on Client | SSL transport encryption should be enabled on both the client and cluster nodes. |
Cluster
| Blacklists | It is possible to specify a blacklist of paths so that paths are rejected and the client receives an error if they try to subscribe to any matching paths. | |
| Cluster Configuration | Before starting, each node needs to have its network settings configured in its config/application.conf file. |
|
| Cluster Failure Cases | As part of the Cluster Performance (defunct) testing, a number of failure modes were encountered. This reference guide describes these. | |
| Cluster Introduction | The Open Access cluster is the bridge between your code and the data available from various ITRS products. | |
| Cluster Logging | The Open Access Cluster uses the SLF4J API for logging with backing from the Logback framework. | |
| Cluster Performance | This page has been superseded by /perf/performance and is here for historical reference only. |
|
| Gateway Connections | Edit the configuration file in config/settings.conf and edit the gateways part of the file to point the host and port at your gateway. |
|
| Gateway Distribution | Gateway connections are dynamically divided amongst the nodes in the cluster. This guide describes how the Gateways are distributed. | |
| Node Failure | The cluster has been designed to be resilient against the failure of individual nodes. This technical reference explains how. | |
| Nodes on *nix | The oaccluster.sh script allows you to start, stop and report on the state of a cluster of nodes on *nix systems. | |
| REST | OpenAccess REST is experimental and should not be used in production. | |
| Run as a Service | The cluster node can be managed using the service script template provided in this technical reference. | |
| Start a Cluster | Once a node has been configured, run the node using the provided oacluster.sh script. |
Cluster Security
| Introduction | An overview of the various cluster security features. | |
| Data Permissions | Permissions specify what data each role can see. They can be restricted based on four conditions. | |
| SSL in the Cluster | Full transport security in the Open Access API is provided by SSL, specifically TLSv1. | |
| User Authentication | User authentication in the cluster is configured via settings.conf or by integrating with an Active Directory server. |
Diagnostics
| Diagnostics Quick Start | The Diagnostics tool is simple Open Access client application capable of connecting to gateways in order to report various statistics. | |
| Diagnostics Requirements | System requirements for the Open AccessDiagnostics tool. | |
| Settings | Settings for the diagnostics configuration file, config/application.conf. |
|
| Use Cases | On this page we demonstrate how to run the tool against a many hundreds of gateways and then aggregate a report. |
Getting Started
| Run API Examples | A user guide describing how to run the API examples. | |
| Run a Cluster Node | The Open Access cluster is the bridge between your code and the data from ITRS products. This guide explains how to run a cluster node. | |
| System Requirements | The following reference outlines the supported platforms and required Java versions to run Open Access. | |
| Write Code | A guide on how to write your own code for the Open Access tool. |
Java Documentation
| Java Documentation | Documentation and reference related to the Java classes and packages for the Open Access tool. |
Migration
| Migration from Prototype | Migration reference guide from the prototype Open Access to version 1.x. | |
| Migration Reference | Migration reference guide for Open Access production versions. |
Monitoring
| Self Monitoring | Self-monitoring allows you to obtain information about the state of the cluster such as node membership, gateway connectivity, client connections and more. |
Performance
| Performance Introduction | An introduction to profiling tests that have provided some insights into how Open Access performs | |
| Performance Methodology | To test the various distributed components of ITRS software (Netprobes, Gateways, Open Access nodes and clients, etc.), we developed an in-house testing framework. | |
| Performance Profiling | Technical reference for performance profiling. |
Performance Results
| AC Lite | This test shows the impact of a single Open Access node with 50 Open Access clients, where the node connects to increasing numbers of Large Gateways in turn. | |
| DataSet | This test shows the performance of a single node connected to 8 Large Gateways, with an increasing number of DataSet queries in a single client. | |
| DataView | This test shows the performance of a single node connected to a Large Gateway, with an increasing number of DataView queries in a single client. | |
| Legacy Clients | This test shows the performance of 4 cluster nodes connected to 30 Legacy Gateways, with an increasing number of clients making 20 DataSet queries. | |
| Legacy Paths | This test shows the performance of 4 cluster nodes connected to 30 Legacy Gateways, with a single client performing an increasing number of DataSet queries. | |
| Nodes | This test examines the effect of increasing the number of nodes in a cluster that connects to 10 Large Gateways. |
Snippets
| Homepage Code Snippet | Example homepage code snippet. |
Utility
| Creating XPaths | This user guide describes how XPath is used to both identify items of data and to construct queries that match multiple items of data. | |
| Data Trackers | The API streams the initial image of data followed by any changes, but it is sometimes useful to maintain the current state of the data in memory. | |
| Synchronous Requests (Snapshots) | Some use cases require snapshot request/response style interaction. |