Debugging endpoints and tools to investigate indexing API issues in Glean
This article reviews helpful debug endpoints you can use to investigate indexing API issues. For a comprehensive document on the different endpoints available for debugging, please review this troubleshooting document. If you require further assistance debugging, the Next Steps section describes what information to share with Glean Support when raising a ticket.
If you want to confirm whether your indexing job was successful, you can use this endpoint to verify if your documents have been uploaded and indexed. The bulkUploadHistory will show the details of your document indexing endpoint time. After documents are uploaded, they will be queued for processing. New documents will be available in search results when the processingHistory timestamp is after the bulkUploadHistory.
If a user reports a missing document, this endpoint can be used to confirm if a document is present in the data source index and verify what permissions this document has. A user will be able to view a document if any of the below criteria is met:
allowAnonymousAccess is true
allowAllDatasourceUsersAccess is true and user has been indexed as a user of the data source
user is a member of the allowedGroups and in the list of allowedUsers OR allowedGroupIntersections
To check if a user has access to view a document in Glean. The response will show true or false. If false, review the debug endpoints debug data source user and debug data source document to check permissions.