Troubleshooting

Alation Cloud Service Applies to Alation Cloud Service instances of Alation

Customer Managed Applies to customer-managed instances of Alation

Endpoints

The following Atlas REST API endpoints are used by the connector. Use tools like Swagger, Postman, or curl to verify you can successfully call these endpoints from the connector host.

GET

  • /api/atlas/v2/search/basic

  • /api/atlas/v2/entity/bulk

  • /api/atlas/v2/entity/guid/{guid}

Extraction Job Status

The Extraction job status table logs the following status:

  • Did Not Start: Indicates that the metadata extraction did not start due to configuration or other issues.

  • Succeeded: Indicates that the extraction was successful.

  • Partial Success: Indicates that the extraction was successful with warnings. If Alation fails to extract some of the objects during the metadata extraction process, it skips them and proceeds with the extraction process, resulting in partial success.

  • Skipped: Indicates that the job was skipped as the previous extraction job was not completed.

  • Failed: Indicates that the extraction failed with errors.

View Details

Click View Details to inspect: - Extraction log output - Bucket-level diagnostics - Errors and warnings (categorized by type)

Download Error Reports

In case of failure: - Click Generate Error Report - Download a .zip archive containing: - CSV files for each error type (e.g., ConnectionErrors.csv, PermissionErrors.csv)

Common Issues

  • Connection failures: - Check network/firewall settings and ensure the Atlas API URL is correct and accessible. - Verify SSL certificates if using HTTPS.

  • Authentication errors: - Confirm the username/password or bearer token is valid and has not expired. - Ensure the service account has the required permissions.

  • Permission denied: - The service account may lack access to certain metadata. Contact your Atlas administrator to review permissions.

  • Timeouts or slow responses: - Check Atlas server health and network latency.

Testing Endpoints

Example curl command for Basic Auth:

curl -u <username>:<password> https://<atlas-server-host>:<port>/api/atlas/v2/search/basic?excludeDeletedEntities=true&limit=1&offset=0&typeName=hive_table

Example curl command for Bearer Token:

curl -H “Authorization: Bearer <token>” https://<atlas-server-host>:<port>/api/atlas/v2/entity/bulk?guid=<guid>&ignoreRelationships=false&minExtInfo=false