Merge branch 'main' of https://github.com/newrelic-experimental/nri-t…

…ibco-ems into main

README.md

@@ -11,10 +11,45 @@ New Relic has open-sourced this integration to enable monitoring of this technol
 
  - New Relic Infrastructure Agent
 
+## Configuration
+
+Edit *tibco-ems-server-config.json* file to edit the tibco server(s) connection information. 
+
+
+| Attribute | Description |
+| --- | --- |
+| name | Name describing the EMS Server |
+| host | DNS name of IP of the EMS Server |
+| port | port number of EMS Server, typically 7222 |
+| username | username for connecting |
+| password | (optional) provide password for user if needed |
+| includeDynamicQueues | flag (true, false) to indicate whether to collect temporary queues |
+| queueIgnores | JSON Array of JSON Object pair "qIgnoreRegEx" and a regular expression to match against queue names |
+| includeDynamicTopics | flag (true, false) to indicate whether to collect temporary topics |
+| topicIgnores | JSON Array of JSON Object pair "tIgnoreRegEx" and a regular expression to match against topic names |
+| channeldetails | whether to collect channel details or not.  default is true |
+
+
+### Ignoring Queues and/or Topics
+The queueIgnores and topicIgnores configuration arrays can be used to ignore queues or topics that are either not of interest or are overloading the metrics resulting in lost metrics.  They are populated with Java regular expressions that are used to match against the actual queue name to see whether it should be ignored or not.   Note that the actual queue name is a regular expression that only matches that name.
+
+*Example*
+Suppose we would like to ignore all queues that start with either TMP or SYS.  Then we would enter the following for queueIgnores:    
+![image](https://user-images.githubusercontent.com/8822859/134726305-aadeb327-f12e-4e85-89c5-ede56a5961f6.png)
+
 ## Installation
 
 1. Extract the Release archive to the local disk
-2. Either run the install script or follow the instructions below for manual installation.
+2. Edit *tibco-ems-server-config.json* according to the Confguration section above.   
+3. Either run the install script or follow the instructions below for manual installation.
+4. Restart the infrastructure agent
+
+```sh
+sudo systemctl stop newrelic-infra
+
+sudo systemctl start newrelic-infra
+```
+
 
 ### By Script
 
@@ -41,41 +76,23 @@ cp tibco-ems-server-config.json /etc/newrelic-infra/integrations.d/
 
 ```
 
-## Configuration
-
-
-
-Edit *tibco-ems-server-config.json* file to edit the tibco server(s) connection information. 
-
-
-| Attribute | Description |
-| --- | --- |
-| name | Name describing the EMS Server |
-| host | DNS name of IP of the EMS Server |
-| port | port number of EMS Server, typically 7222 |
-| username | username for connecting |
-| password | (optional) provide password for user if needed |
-| includeDynamicQueues | flag (true, false) to indicate whether to collect temporary queues |
-| queueIgnores | JSON Array of JSON Object pair "qIgnoreRegEx" and a regular expression to match against queue names |
-| includeDynamicTopics | flag (true, false) to indicate whether to collect temporary topics |
-| topicIgnores | JSON Array of JSON Object pair "tIgnoreRegEx" and a regular expression to match against topic names |
-
-
-
-Finally verify that the path to *tibco-ems.jar* in the *tibco-ems-definition.yml* file.
-
-Restart the infrastructure agent
-
-```sh
-sudo systemctl stop newrelic-infra
-
-sudo systemctl start newrelic-infra
-```
-
 ## Usage
 
-You can view your data in Insights by creating your own custom NRQL queries. To
-do so use **EMS**.. event types.
+The data collected is reported to New Relic as Custom Events.  The following is a list of events that can be reported.   An event is only recorded if data present for that item so not all events may be reported.
+
+### Event Types
+
+| Event Type | Description |
+| ---- | ---- |
+| **EMSQueue** | Metrics related to an EMS Queue.  Attribute "Queue Name" is the name of the queue |
+| **EMSQueueTotals** | Contains the sums of certain metrics across all recorded queues |
+| **EMSTopic** | Metrics related to an EMS Topic.  Attribute "Topic Name" is the name of the topic |
+| **EMSTopicTotals** | Contains the sums of certain metrics across all recorded topics |
+| **EMSRoute** | Metrics related to an EMS Route.  Attribute "Route Name" is the name of the route |
+| **EMSRouteTotals** | Contains the sums of certain metrics across all recorded routes |
+| **EMSChannel** | Metrics related to an EMS Channel.  Attribute "Channel Name" is the name of the channel |
+| **EMSChannelDetails** | Contains more detailed information about a channel |
+| **EMSBridge** | Metrics related to an EMS Bridge.  Attribute "Bridge Name" is the name of the bridge |
 
 ## Compatibility