feat(FDSE-3324): add directory and usage modular inputs - #48
Open
Arthur-10-coder wants to merge 5 commits into
Open
feat(FDSE-3324): add directory and usage modular inputs#48Arthur-10-coder wants to merge 5 commits into
Arthur-10-coder wants to merge 5 commits into
Conversation
Implements the official solution approved by Ashley Hoang and Erica Pescio:
- users_directory: GET /api/v2/users snapshot (genesyscloud:directory:users)
- queues_directory: GET /api/v2/routing/queues snapshot (genesyscloud:directory:queues)
- usage_events: POST /api/v2/usage/events/query (genesyscloud:usage:events)
- org_usage: POST /api/v2/usage/aggregates/query/jobs (genesyscloud:usage:organization)
- oauth_client_usage: POST /api/v2/usage/client/{id}/aggregates/query/jobs (genesyscloud:usage:oauth_clients)
The usage inputs replace the deprecated POST /api/v2/usage/query endpoints
scheduled for removal on Oct 16, 2026. Directory inputs use daily snapshots
(86400s interval) to provide lookup-compatible ID-to-name correlation data.
Ref: https://splunk.atlassian.net/browse/FDSE-3324
Arthur-10-coder
force-pushed
the
FDSE-3324-directory-inputs-and-usage
branch
2 times, most recently
from
August 11, 2026 21:22
d3b7680 to
8974d2b
Compare
Remove directory inputs (users, queues) per Erica's feedback — those become CSCs in the App repo. Keep only the 3 usage/operational inputs with her naming convention, add mock routes, CI config, integration and functional tests, docs, and bump version to 0.5.0.
edro15
requested changes
Aug 12, 2026
edro15
left a comment
edro15
left a comment
Collaborator
There was a problem hiding this comment.
@Arthur-10-coder Please have a look at these changes and comments.
| - [Configure an integration application in Genesys Cloud for the Genesys Cloud Add-on for Splunk](../ConfigureGenesysCloud/index.md) | ||
| - [Configure an account in the Genesys Cloud Add-on for Splunk](../ConfigureAccount/index.md) | ||
|
|
||
| **OAuth scopes required (for usage inputs):** `usage:readonly` |
Collaborator
There was a problem hiding this comment.
Suggested change
| **OAuth scopes required (for usage inputs):** `usage:readonly` |
Please move this information to the table at docs/ConfigureGenesysCloud/index.md. ALL necessary permissions for ALL inputs MUST be added to that table following given format
Comment on lines
+105
to
+111
| ## Usage Inputs Reference | ||
|
|
||
| | Input | API Endpoint | Sourcetype | | ||
| |-------|-------------|------------| | ||
| | `operational_events` | `POST /api/v2/usage/events/query` | `genesyscloud:operational:events` | | ||
| | `org_api_usage` | `POST /api/v2/usage/aggregates/query/jobs` | `genesyscloud:operational:usage:api` | | ||
| | `clients_api_usage` | `POST /api/v2/usage/client/{id}/aggregates/query/jobs` | `genesyscloud:operational:usage:clients_api` | |
Collaborator
There was a problem hiding this comment.
Suggested change
| ## Usage Inputs Reference | |
| | Input | API Endpoint | Sourcetype | | |
| |-------|-------------|------------| | |
| | `operational_events` | `POST /api/v2/usage/events/query` | `genesyscloud:operational:events` | | |
| | `org_api_usage` | `POST /api/v2/usage/aggregates/query/jobs` | `genesyscloud:operational:usage:api` | | |
| | `clients_api_usage` | `POST /api/v2/usage/client/{id}/aggregates/query/jobs` | `genesyscloud:operational:usage:clients_api` | |
This is not aligned with other inputs documentation. To be removed.
Comment on lines
+18
to
+20
| | `genesyscloud:operational:events` | API usage event records (per-request detail) | | ||
| | `genesyscloud:operational:usage:api` | Organization-level API usage aggregates | | ||
| | `genesyscloud:operational:usage:clients_api` | Per-OAuth-client API usage aggregates | |
Collaborator
There was a problem hiding this comment.
Suggested change
| | `genesyscloud:operational:events` | API usage event records (per-request detail) | | |
| | `genesyscloud:operational:usage:api` | Organization-level API usage aggregates | | |
| | `genesyscloud:operational:usage:clients_api` | Per-OAuth-client API usage aggregates | | |
| | `genesyscloud:operational:events` | All API usage event records | | |
| | `genesyscloud:operational:usage:api` | All organization-level API usage aggregates | | |
| | `genesyscloud:operational:usage:clients_api` | All OAuth client API usage aggregates | |
| "field": "account", | ||
| "required": true | ||
| } | ||
| ], |
Collaborator
There was a problem hiding this comment.
Missing max_poll_attempts and poll_interval_seconds to avoid hard-coded values.
| } | ||
| ], | ||
| "inputHelperModule": "clients_api_usage_helper", | ||
| "title": "OAuth Client Usage", |
Collaborator
There was a problem hiding this comment.
Suggested change
| "title": "OAuth Client Usage", | |
| "title": "OAuth Client API Usage", |
| ], | ||
| "inputHelperModule": "clients_api_usage_helper", | ||
| "title": "OAuth Client Usage", | ||
| "description": "Ingest per-OAuth-client usage aggregates (POST /api/v2/usage/client/{clientId}/aggregates/query/jobs). Requires OAuth scope: usage:readonly." |
Collaborator
There was a problem hiding this comment.
Suggested change
| "description": "Ingest per-OAuth-client usage aggregates (POST /api/v2/usage/client/{clientId}/aggregates/query/jobs). Requires OAuth scope: usage:readonly." | |
| "description": "Ingest OAuth clients API usage aggregates." |
| "field": "oauth_client_id", | ||
| "help": "The OAuth client ID to query usage for. If empty, queries usage for all clients.", | ||
| "required": false | ||
| } |
Co-authored-by: Erica Pescio <epescio@splunk.com>
Co-authored-by: Erica Pescio <epescio@splunk.com>
Co-authored-by: Erica Pescio <epescio@splunk.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
users_directory,queues_directory,usage_events,org_usage, andoauth_client_usagePOST /api/v2/usage/queryandPOST /api/v2/oauth/clients/{clientId}/usage/queryendpoints (removal deadline: Oct 16, 2026)Context
Jira: https://splunk.atlassian.net/browse/FDSE-3324
Changes
globalConfig.jsonpackage/bin/users_directory_helper.pyGET /api/v2/users→ sourcetypegenesyscloud:directory:userspackage/bin/queues_directory_helper.pyGET /api/v2/routing/queues→ sourcetypegenesyscloud:directory:queuespackage/bin/usage_events_helper.pyPOST /api/v2/usage/events/query→ sourcetypegenesyscloud:usage:eventspackage/bin/org_usage_helper.pyPOST /api/v2/usage/aggregates/query/jobs→ sourcetypegenesyscloud:usage:organizationpackage/bin/oauth_client_usage_helper.pyPOST /api/v2/usage/client/{id}/aggregates/query/jobs→ sourcetypegenesyscloud:usage:oauth_clientsTechnical Notes
genesyscloud_client.py)users:readonly,routing:readonly,usage:readonlyFollow-up (separate PR)
| genesysusers,| genesysqueues) will be added togenesys_cloud_app_for_splunk— these live in the App, not the TA, per architectural decision