Box Connector 24.2

# View Connector Statistics

Box Connector collects statistics about the work it has completed. The statistics that are available depend on the connector you are using, but all connectors provide information about the number and frequency of ingest-adds, ingest-updates, and ingest-deletes.

To view connector statistics

- Use the `GetStatistics` service action, for example:

      http://host:serviceport/action=GetStatistics

  where `host` is the host name or IP address of the machine where the connector is installed, and `serviceport` is the connector’s service port.

  For information about the statistics that are returned, refer to the documentation for the `GetStatistics` service action.

The connector includes an XSL template (`ConnectorStatistics.tmpl`) that you can use to visualize the statistics. You can use the template by adding the `template` parameter to the request:

    http://host:serviceport/action=GetStatistics&template=ConnectorStatistics

When you are using the `ConnectorStatistics` template, you can also add the `filter` parameter to the request to return specific statistics. The `filter` parameter accepts a regular expression that matches against the string `autnid::name`, where `autnid` and `name` are the values of the corresponding attributes in the XML returned by the `GetStatistics` action. For example, the following request returns statistics only for synchronize actions:

    http://host:serviceport/action=GetStatistics&template=ConnectorStatistics
                                                &filter=^synchronize:

The following request returns statistics only for the task `mytask`:

    http://host:serviceport/action=GetStatistics&template=ConnectorStatistics
                                                &filter=:mytask:

The following image shows some example statistics returned by a connector:

Above each chart is a title, for example `SYNCHRONIZE:MYTASK`, that specifies the action and task to which the statistics belong.

You can see from the example that in the last 60 seconds, the connector has generated an average of approximately 0.4 ingest-adds per second. In the charts, partially transparent bars indicate that the connector has not completed collecting information for those time intervals. The information used to generate statistics is stored in memory, so is lost if you stop the connector.

The following information is presented above the chart for each statistic:

- Total is a running total since the connector started. In the example above, there have been 70 ingest-adds in total.
- Current Total is the total for the actions that are currently running. In the example above, the synchronize action that is running has resulted in 30 ingest-adds being sent to CFS.
- Previous Total provides the totals for previous actions. In the example above, the previous synchronize cycle resulted in 40 ingest-adds. To see the totals for the 24 most recent actions, hover the mouse pointer over the value.

Copyright 2024 Open Text
Version 24.2 | Last updated March 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL Box Connector 24.2

Topic Title: View Connector Statistics