|Publication:||Jan 11, 2021|
nJAMS Agent is the nJAMS component that collects Metrics and provides them to nJAMS Argos. The configuration of input and output plugins specifies what kind of data the nJAMS Agent is collecting, and how it is sent to nJAMS Server.
nJAMS Argos provides visibility of applications and infrastructure and acts as a component within nJAMS Server and nJAMS Cloud. Argos completes the view on processes with Metrics from application and infrastructure monitoring. Argos is supplied with Metrics from nJAMS Agent.
An Attribute in context of nJAMS represents a name/value pair of additional information that can be passed within a Log Event. Attributes are usually used to add functional information to technical Log Events, such as order id or customer name. Attributes allow you to search for Log Entries by a particular business related information. In contrast to Business Object and Business Service, Attributes are not fixed to their meaning, but can be freely defined. Attributes are determined by an Extract or by using nJAMS Log Activities. Attribute pairs appear on a Tile of the Result List.
In context of nJAMS, a Business Object is a label for a Log Entry. This label allows to retrieve the Log Entry in nJAMS GUI using the name of the corresponding Business Object. Business Objects are arranged in the Tree. A hierarchy of Business Objects is possible. A Business Object is determined by an Extract or by using nJAMS Log Activities. A Business Object could be: order, creditor, debtor, product, etc. For example, when you select Business Object order from the Business Object Tree in nJAMS GUI, you will get a list of Log Entries that are tagged with order.
A Business Service in nJAMS represents a label for a Log Entry. This label allows to retrieve the Log Entry in nJAMS GUI using the name of the corresponding Business Service. Business Services are arranged in the Tree. A hierarchy of services is possible. A Business Service is determined by an Extract or by using nJAMS Log Activities. A Business Service could be: order service, invoice verification, credit check service, etc. For example, when you select Business Service invoice verification from the Business Service Tree in nJAMS GUI, you will get a list of Log Entries that are tagged with this service.
The nJAMS Client is the sensor that provides insight into Process Executions of the monitored system. There are individual nJAMS Clients providing unique capabilities to monitor various integration platforms and applications. An nJAMS Client is able to monitor each individual Process Execution and can correlate their transactions. nJAMS Client acts as a plug-in within the monitored system.
nJAMS Cloud represents an nJAMS offering that provides a subscription for an nJAMS Instance as a service. An nJAMS Cloud Instance is a fully managed service by Integration Matters. You only have to connect an nJAMS Client to your nJAMS Cloud Instance and you are ready to monitor your integration platform and get process insight of your applications.
compress successful transactions¶
Compress Successful Transactions is a property of a Domain Object. This setting allows to discard monitoring information about the execution path of successfully executed processes. Enabling this setting is an option to reduce the data volume stored by nJAMS.
Refer to: domain object
In context of nJAMS, a Correlation stands for a series of correlated Log Entries. Correlated Log Entries are created, when Process Executions follow each other and are therefore interconnected. For example, assume “Process A” calls “Process B”. Processes “A” and “B” are connected, respectively correlated. nJAMS creates separate Log Entries for processes “A” and “B” and correlates the Log Entries automatically using a common unique Correlation Id.
The Correlation Id is a unique identifier for correlated Log Entries.
A Data Provider is a component in nJAMS Server that receives and processes incoming Log Messages sent by nJAMS Client. The Data Provider is basically feeding data into nJAMS Server. In addition, the Data Provider can also receive and process messages containing Metrics from nJAMS Agent. The Data Provider requires a connection to a JMS Provider.
Data Retention determines the duration of storing data in nJAMS. Basically all data in nJAMS is expiring. You can change the expiration of data by configuring Data Retention for Domain Objects, Metrics, notifications, etc.
A Domain Object represents a technical category of the monitored system, such as domain, application, process, etc. Domain Objects are usually organized in a hierarchical structure and are arranged in tree view in nJAMS GUI. The properties of Domain Objects can be configured, for example, to determine the duration of Data Retention. You can also grant permissions to Domain Objects in order to restrict access to Log Entries per Domain Object.
domain object path¶
The Domain Object Path is the complete path of a Domain Object, from the root to the selected element. Similar to a folder structure, Domain Objects are arranged hierarchically. The individual elements in the path are separated by character “>”.
A Domain Object Path looks like this, for example:
This is an example, where the Domain Object Path only consists of the root element:
Elasticsearch, respectively elastic, is the storage system used by nJAMS for persisting data like Log Messages, Metrics, statistics, etc. Though actually an indexing system, nJAMS uses Elasticsearch as datastore also. Elastic is actually the vendor company of Elasticsearch, but this term is also often used as short form for Elasticsearch. See also: https://www.elasticsearch.com
Engine refers to the execution unit of the monitored system, where applications and processes are executed. An Engine can be represented by a JVM or another runtime environment. |TIBBW| or |MULERUNTIME| are examples of integration platforms whose execution units we refer to as Engines.
Refer to: process execution
The Event List represents the list of Log Events of a Log Entry in nJAMS GUI.
In context of nJAMS, the Event Status represents the Severity level of a Log Event.
The Event Status can consist of the following Severity levels:
The Status of a Log Entry is in turn calculated from a sequence of Event Statuses.
Explicit Logging complements Implicit Logging with explicit Log Events.
nJAMS Client can create additional Log Events by using an Extract or by using nJAMS Log Activities.
A Log Event is also created explicitly, when an activity is executed that has Tracing enabled.
Explicit Logging is used in combination with Implicit Logging, when Log Mode is
Explicit Logging is used exclusively, when Log Mode is
When Explicit Logging is used exclusively, nJAMS Client will only monitor Process Executions, where a Log Event has been created explicitly.
An Extract allows you to create nJAMS Log Events on any activity regarding a process definition of the monitored system. The Extract definition takes place Non-Invasively at runtime, which means Log Events can be added or removed at any time during runtime without modifying the process design model.
IM Flows represents an nJAMS extension that allows to create a model of your business flow. The flow model is based on rules that evaluate incoming Log Events from monitored Process Executions. Flows acts as a meta layer above the process implementation. With IM Flows you can benchmark the execution of your business flows in various ways.
A second meaning of Flows is related to the Mule integration platform. MuleSoft™ applications are made up of flows. Flows in context of Mule is similar to the meaning of processes in TIBCO ActiveMatrix BusinessWorks™, another integration platform monitored by nJAMS.
A Flows Instance represents the execution of a IM Flows model. A Flows Instance runs within nJAMS Server. A Flows Instance is started rule-based on incoming Events.
Refer to: flows
nJAMS provides a graphical user interface (gui) to search for Log Entries and visualize monitor data in various ways. nJAMS GUI is part of an nJAMS Instance and available by using common web browsers. Furthermore, nJAMS GUI allows to manage your nJAMS Instance, such as user administration, authorization assignment, control message processing, etc.
nJAMS Hub stands for the central web portal to manage your nJAMS account at Integration Matters. Once you logged in into your account, you can use nJAMS Hub to enter your nJAMS Cloud Instances, get your Instance key to connect nJAMS Client against your nJAMS Cloud Instance, invite additional users to work with your Instances and update your organization. nJAMS Hub is available at: https://hub.integrationmatters.com/
In nJAMS Implicit Logging means nJAMS Client is automatically collecting Events of a Process Execution once it is enabled.
When Implicit Logging is on, you do not have to worry about creating Log Events at certain places of your process.
nJAMS Client automatically detects, when a process has started and ended.
If errors occur during execution, they are also detected and logged automatically.
Implicit Logging is enabled, when Log Mode is
Implicit Logging is turned off, when Log Mode is
In this case, nJAMS Client exclusively uses Explicit Logging.
An Index is the coarsest unit in Elasticsearch for structuring data. nJAMS organizes its data into separate Indexes by type of data (e.g. monitor data, statistics, Metrics, etc.), and each Index type again utilizes multiple Indexes according to Data Retention. Each nJAMS Index contains an expiration date. The data is stored into the Index of the corresponding type with the expiration date that best reflects the actual data storage. Depending on the expected data volume, Indexes are created on a daily, weekly or monthly basis.
The Indexer client is the component in nJAMS Server that connects to the persistent storage system and is responsible for storing and retrieving data. nJAMS Server uses Elasticsearch as data storage technology. When the Indexer client is stopped, neither new data can be stored, nor existing data can be retrieved from the storage system, i.e. the entire message processing is stopped.
An nJAMS Instance is the central unit for receiving, processing, and storing Log Messages. In addition, the nJAMS Instance provides a graphical user interface (gui) to allow searching for Log Entries and presenting the search results. The nJAMS Instance is provided by an on-premise nJAMS Server installation, or by a managed service via an nJAMS Cloud subscription.
In context of nJAMS, Invasively stands for a monitoring mode, where the process model needs to be modified in order to initialize and use nJAMS Client. In other words, when you decide to use nJAMS Log Activities within your process design, you are monitoring your applications invasively. By default, nJAMS Client is used Non-Invasively.
Refer to: non-invasively
A JMS Provider is a messaging system that implements the JMS interfaces and provides administrative and control features. nJAMS Server and nJAMS Client use the JMS Provider for communication. Popular JMS providers supported by nJAMS are TIBCO Enterprise Message Service™ and ActiveMQ. nJAMS Cloud does NOT use JMS for communication with nJAMS Client, instead nJAMS Cloud uses secure transport communication via TLS/HTTPS.
Refer to: data provider
nJAMS Log Activities are used at design time and can be placed anywhere between start and end of a process model of the monitored application. Similar to Extracts, nJAMS Log Activities are used to send Log Events. Since nJAMS Log Activities are used at design time, they are part of the process design and are therefore always available in any environment, where the application is deployed. At present, Log Activities are available for nJAMS Client for BW and nJAMS Client for BW6.
In nJAMS a Log Entry is the representation of a Process Execution. Each Log Entry has a unique Log Id and is represented by an entry in the Result List of nJAMS GUI. A Log Entry contains several information regarding a Process Execution, such as start/end time, duration, Status, Process Execution Path, etc. A Log Entry can contain additional associated Log Events. Log entry is a synonym for Main Entry.
A Log Event represents an Event that is triggered while monitoring a Process Execution. A Log Event is sent via an Event Message. A Log Event has an Event Status and can contain a number of additional information, such as Payload, Stacktrace, Attributes, etc. A Log Event is triggered implicitly by nJAMS Client, if an unhandled exception occurs. Furthermore, additional Log Events can be triggered explicitly from any activity during a Process Execution by using an Extract or by using nJAMS Log Activities.
A Log Id is a unique identifier for a Log Entry.
A Log Message carries information about Log Events monitored by nJAMS Client. A Log Message is sent from nJAMS Client to nJAMS Server, respectively nJAMS Cloud.
The term Log Level is used in nJAMS to determine the Severity of a Log Event to be passed to an nJAMS Instance.
The Log Level can be configured for a Domain Object at process level.
For example, you may want to avoid the clutter of successful Log Entries related to a Process Execution, where you are only interested in things that went wrong.
To do this, you can configure the Log Level for the Domain Object of this process to
nJAMS Client will then only send Log Events with Status of Severity
warning or higher.
In context of nJAMS, Log Mode determines the basic functionality of an nJAMS Client and affects the monitoring of the entire Engine.
When Log Mode is
complete, nJAMS Client is fully enabled, which is the default setting.
none disables the client and thus turns off monitoring of the Engine entirely.
You can configure Log Mode to
exclusive, if you only want to monitor Process Executions of the Engine, when an activity is executed that explicitly creates a Log Event, or has Tracing enabled, or was applied with an Extract.
In other words, Log Mode
exclusive disables implicit logging by exclusively using Explicit Logging.
This monitoring mode is commonly used, if you want to reduce the amount of Log Entries, but still want to monitor Process Executions with relevance.
In context of nJAMS, a Main Entry is the representation of a Process Execution. Main entry is a synonym for Log Entry.
Main List represents the list of results after performing a search in Main View of nJAMS GUI. Main list is a synonym for Result List.
Main View is the main page of nJAMS GUI. From this page you can search for Log Entries in various ways and view the search results and details.
The Message Format describes the format of a Log Message. The current Message Format (V4) is composed of a JSON structure, whereas the previous Message Format (V3) consists of an XML structure. Modern nJAMS Clients starting with version 4 send their information in V4 format. The V3 Message Format is deprecated.
Refer to: log message
Metrics are data tracked over time. nJAMS Agent collects Metrics and sends them to nJAMS Argos.
The Monitored System represents the system that is monitored by nJAMS. nJAMS provides individual nJAMS Clients for various integration platforms and applications.
Refer to: client
nJAMS is the product brand and stands for the short form of not Just Another Monitoring Solution.
Using nJAMS Client Non-Invasively means, nJAMS Client monitors an application instantly without interfering and changing the process design. Running nJAMS Client Non-Invasively is the default monitoring mode. In contrast, you can use nJAMS Client Invasively by using nJAMS Log Activities.
The notification Center collects notifications issued by your nJAMS Instance. Here you can track, for example, when a Data Provider was last started, when a replay was triggered, or if there was a technical problem. The Notification Center can be accessed via the nJAMS GUI.
Refer to: gui
The nJAMS Palette is a set of nJAMS Log Activities that are used to send Log Events. nJAMS palette is an integral part of nJAMS Client for BW and nJAMS Client for BW6.
Refer to: log activity
parent log id¶
The Parent Log iId is the unique Log Id of a correlated preceding Log Entry. Within a Correlation chain, a correlated Log Entry can have one single preceding Log Entry, but several subsequent Log Entries.
Payload in context of nJAMS represents the passed data or message during a Process Execution. The Payload is of particular interest during a Process Execution. Very often one would like to monitor the incoming message as well as the transformation of the message during the Process Execution.
Refer to: process execution
Process Definition represents the design of a process model of the monitored system. Process Design and Process Model are used as a synonym for Process Definition.
Refer to: process diagram
A Process Diagram is the graphical representation of a Process Model in nJAMS GUI. Depending on the selection in nJAMS GUI, the Process Diagram either shows the Process Definition or the instantiated Process Model including the Process Execution Path. When you select a process entry in the Tree, the Process Diagram shows the Process Definition. Whereas when you select an entry from the Result List, the Process Diagram shows the Instance of the Process Model in the state at the time of execution.
Process Execution stands for the execution of a process model. When a process is executed, an Instance of the process model is created. An instantiated process model gets an id, the Job id, from the Engine that runs the process Instance. In nJAMS each Process Execution is represented by a corresponding Log Entry. Connected Process Executions are represented by correlated Log Entries. Process execution is a synonym for Process Instance.
process execution path¶
The Process Execution Path describes the path that was taken during a Process Execution. The Process Execution Path is indicated in the Process Diagram by green colored transitions between activities and by a green badge at the executed activities.
The Process Instance is the instantiation of a Process Definition. Process Instance is used as a synonym for Process Execution.
A Project Message carries information about Process Definition and configuration of the monitored system. When the monitored system is starting up, a Project Message is sent from nJAMS Client to nJAMS Server, respectively to nJAMS Cloud
With a Query you can perform complex searches for Log Entries. Multiple search terms can be combined with operators. A full text search is also possible. The Query is available in the nJAMS GUI and complements the simple search elements of nJAMS GUI.
In context of nJAMS, Recording stands for saving the input data of a start activity during a Process Execution. The Recorded Data is used by nJAMS Replay to retrigger a Process Execution using the previously saved input data. Recording can be switched on/off per Engine or per individual process.
Recorded Data represents the saved data of an input activity during a Process Execution. The Recorded Data is used by nJAMS Replay to retrigger a Process Execution using the previously saved input data.
nJAMS Replay extends nJAMS monitoring capabilities with the ability to launch Process Executions within a monitored application. Retriggering a Process Execution based on the original or modified input data is called Replay. Any replayed Process Instance is audited, i.e. you can track who started a Replay at what time. Using Replay can be restricted by certain permissions.
The Result List represents the list of hits after performing a search in Main View of nJAMS GUI. The Result List contains Log Entries of corresponding Process Executions according to specified search criteria. An entry in the Result List on Main View of nJAMS GUI is called a Tile.
The nJAMS software development kit (SDK) is the fundamental basis for all common nJAMS Clients and allows developing additional nJAMS Clients for further integration platforms or applications that should be monitored by nJAMS. The SDK provides the general functionality for nJAMS Clients, such as communication with nJAMS Server.
Refer to: client
The installation of nJAMS Server provides an on-premise Instance of nJAMS. In contrast to nJAMS Cloud the nJAMS Server runs in customer’s data center or private cloud. An nJAMS Server Instance is based on WildFly application server and uses an Elasticsearch cluster for persisting monitor data and a JMS Provider for communication with nJAMS Client.
The term Severity is used in nJAMS to determine the highest Severity of a sequence of Event Statuses.
The Severity can consist of the following Severity levels:
For example, assume a Process Execution creates two Log Events, one of Severity level
info, one of
The actual Severity of the Process Execution, respectively the corresponding Log Entry, is then calculated with
error is the highest Severity level of both Log Events.
In combination with Status you can then evaluate the overall success of the Process Execution.
For example, if Status is
success, but Severity shows
error, you know the overall execution of the process was successful even though there were errors during execution.
The Stacktrace is part of a Log Event and contains information about the technical error during a Process Execution. The Stacktrace is provided by nJAMS Client implicitly, in case the error of a failing activity is not captured. If an exception handling is in place, you have the choice to explicitly log an Event including the Stacktrace.
In nJAMS the Status represents the Severity of a Log Entry.
The Status can consist of the following Severity levels:
The Status is calculated by a sequence of Event Statuses.
A Subagent is a built-in agent in nJAMS Client. The Subagent collects metric data from the monitored system and forwards the Metrics to nJAMS Agent.
A Tile represents a Log Entry in the Result List of nJAMS GUI and contains information about a Process Execution. Another meaning of Tile is used in context of custom reports, where a Tile represents the area for a chart type.
The term Trace Point is used in nJAMS for enabled Tracing on a particular activity.
Refer to: tracing
In the world of nJAMS, Tracing means to collect additional logging information with regards to an activity during a Process Execution. Tracing has to be enabled specifically for an activity. By default, Tracing is disabled. When Tracing is turned on, nJAMS collects data of the input and output structure of an activity while the process is executed. Tracing is often used for testing purposes or for analyzing data quality issues in production.
Refer to: trace point
In context of nJAMS, Track is used as a synonym for Process Execution Path. The Process Execution Path is indicated in the process diagram by green colored transitions between activities and by a green badge at the executed activities.
The Tree is used in nJAMS GUI to navigate between Domain Objects. Since Domain Objects are organized hierarchically, the Tree is the ideal representation of Domain Objects. The Tree can be arranged vertically or horizontally. Clicking on an element of the Tree instantly triggers a search for Log Entries.
The WAR file format is an W**eb Application **AR**chive. The |SERVER| WAR file contains the |SERVER| application. The |SERVER| application is deployed on **WildFly Application Server.