In many Oracle Integration Cloud (OIC) implementations, on-premise and hybrid integrations depend heavily on Connectivity Agents. If an agent becomes unavailable, integrations may fail, causing business disruptions. To proactively monitor agent availability, we developed a reusable OIC Agent Health Check Service that leverages the OIC Monitoring REST API.
Objective
The purpose of this service is to:
Monitor Connectivity Agent Groups.
Verify agent health status.
Detect offline or unhealthy agents.
Provide a reusable monitoring framework across environments.
Support automated alerting and operational dashboards.
API Used
The service invokes the OIC Monitoring API:
Http
GET /ic/api/integration/v1/monitoring/agentgroups
Oracle docs reference:
Dynamic Endpoint Mapping
To make the solution reusable across environments (DEV, SIT, UAT, PROD), the endpoint URL is dynamically constructed using OIC Lookup Values.
During the mapper stage:
Environment details are read from common lookups.
Runtime Base URL is fetched dynamically.
Runtime Service Instance is fetched dynamically.
Absolute Endpoint URL is generated.
API is invoked against the appropriate OIC instance.
This approach eliminates hardcoded URLs and simplifies migration across environments.
Benefits
Environment-independent design.
Easier deployment and maintenance.
Centralized configuration management.
Reduced migration effort.
Integration Flow
Step 1: Scheduled Trigger
The integration runs on a schedule (for example every 15 or 30 minutes).
Step 2: Build Monitoring Endpoint
Mapper constructs the endpoint using lookup values and environment configuration.
Step 3: Invoke OIC Monitoring API
The service calls:
Http
GET /ic/api/integration/v1/monitoring/agentgroups
Step 4: Parse Response
Response is parsed to retrieve:
Agent Group Name
Agent Identifier
Agent Status
Connectivity Information
Step 5: Evaluate Health Status
Business rules determine whether:
Agent is Active
Agent is Offline
Agent requires attention
Step 6: Generate Alert
If any agent is unavailable, notifications can be sent through:
Microsoft Teams
Slack
Incident Management Systems
Sample Response Payload
JSON
{
"items": [
{
"id": "AgentGroup01",
"name": "FinanceAgentGroup",
"status": "ACTIVE",
"agents": [
{
"agentId": "Agent001",
"agentName": "FIN_AGENT",
"status": "ACTIVE"
}
]
},
{
"id": "AgentGroup02",
"name": "HRAgentGroup",
"status": "INACTIVE",
"agents": [
{
"agentId": "Agent002",
"agentName": "HR_AGENT",
"status": "INACTIVE"
}
]
}
]
}
Note: The actual payload structure may vary depending on the OIC version and API response.
Key Advantages
Proactive monitoring of OIC Connectivity Agents.
Faster identification of connectivity issues.
Reduced integration downtime.
Reusable common utility service.
Dynamic environment handling through lookup-driven endpoint configuration.
Easy integration with enterprise monitoring solutions.
Conclusion
The OIC Agent Health Check Service provides a centralized and reusable mechanism for monitoring Connectivity Agent availability across environments. By combining the OIC Monitoring API with dynamic endpoint configuration through lookups, organizations can build a scalable monitoring solution that improves reliability, reduces operational effort, and enables proactive issue resolution before business integrations are impacted.
No comments:
Post a Comment