Connector view

The Connector view transforms how you interact with API data sources in KODE OS. It moves beyond a static view to a dynamic and powerful command center, giving you real-time visibility and control over your data integrations.

To open the Connector view, 

• In Data Sources, select a data connection. The Connector View for that data connection appears, displaying the Analytics tab. 

Connection details and activity

There are four buttons in the upper-right corner of the page that enable you to view the details of the data connection, view connection activity, and edit the connection. 

• Test Connections:  

• Details: Opens the Details panel, showing the details of the data connection. 

• Activity: Opens the Activity panel. You can select a date range [???] 

• Three-dots: Opens the Options menu. You can edit or delete the data connection and discover schedules. 

Manage your connections

This article provides instructions on how to monitor, configure, and troubleshoot your data connections to help ensure operational efficiency. The connector view is divided into two tabs: Health and Analytics.

Analytics tab

The Analytics tab provides a detailed look into the data collected by your connector and provides discovery statistics. It helps you understand the volume of data processed and the status of discovered devices and points. 

Overview

This section provides a high-level summary of the entities discovered and managed by the connector.

• Devices: The number of discovered devices is shown here, along with a health status badge (for example, 75% OK). The modeled vs total metric indicates how many of the discovered devices have been successfully modeled within the system.

• Points: This shows the total number of data points discovered, with a breakdown of how many are modeled versus the total discovered.

• Schedules: Displays the number of schedules. Click View All to open the Schedules List. 

• Assets: Displays the number of assets. Click View All to open the Devices List. 

Data Stream

The Data Stream section provides valuable insights into the volume and health of your data collection.

• Collection Activity: Shows the total number of items collected In Range (in the last 7 days) and All time. It also provides a timeline of the next and last collection times and indicates how long the connector has been active.

• Data Stream Graph: A detailed bar graph displays the collection activity over time. Green bars represent items that were successfully collected, while red bars show items that failed. This visual aid is crucial for identifying trends or sudden drops in data collection.

Modify data collection frequency 

To modify the data collection frequency,

1. On the Analytics tab, go to the Collection Activity section.

2. Click the pencil icon next to the current frequency setting. The Data Collection Status pop-up window appears.

3. Choose a new frequency from the available options.

• Every: Positive number. 

• Time: Seconds, Minutes, Hours, or Days.

4. Click Apply. 

Pause data collection

To pause data collection for an entity.

1. On the Analytics tab, go to the Collection Activity section.

2. Click the pencil icon next to the current frequency setting. The Data Collection Status pop-up window appears.

3. To the left of Data Collection Status click the slider off. 

4. Click Apply. The connector stops fetching and storing data from that entity.
   You can always restart data collection by clicking the slider on.

Health tab

The Health tab provides a real-time overview of the connector's operational status and helps you quickly identify and diagnose issues.

Uptime activity

This section offers a visual and numerical summary of your connector's performance.

• Failures: The number of failures that have occurred in the selected date range is displayed prominently. A failure is an event where the connector was unable to collect data. 

• Uptime: The uptime percentage shows the proportion of time the connector has been running successfully.

• Uptime Graph: A color-coded bar graph visualizes periods of uptime and downtime. Green sections indicate periods when the connector was up, while red sections indicate it was down.

The default time period is seven days. Use the calendar to select a different date range. You can choose from: Yesterday,
Last 2 Days, Last 7 Days, Last 30 Days, This Month, or another date.

Error Logs

The Error Logs table provides granular detail on each failure event, which is essential for troubleshooting.

• Date and Time: Displays the exact timestamp of each error, helping you correlate a failure with a specific event or change.

• Error Message: Provides a concise description of the error, such as a connection timeout or a refusal to connect.

Select a log entry to view more detailed information about the cause of the failure. 

Troubleshooting Common Issues

Use the information available in the new view to diagnose and resolve issues with your connector.

1. Check the Activity log. If you notice an unexpected dip in the uptime graph, review the activity log to see if any recent changes were made to the connector that might have caused the issue.

2. Verify connection details. If the connector is experiencing failures, check the connection details in the Edit view to ensure the API keys or URLs are correct.

3. Cross-reference with the Data Stream graph. Look for a correlation between recent changes in the activity log and any changes in the data collection activity graph. A configuration change might have impacted the number of successful items.