Log Analytics API

Dynatrace log analytics provides direct access to the log content of all your system's mission-critical processes and enables you to quickly search for specific log messages.

The Log Analytics API enables you to:

  • Get the list available operating system or process group logs.
  • Start a log analysis job for any existing log.
  • Get the status of a log analysis job.
  • Get the content of a log.
  • Delete or cancel a log analysis job.

The Log Analytics API isn't available with the free tier of OneAgent log analysis. The API is only available for Dynatrace environments that have a paid Log Analytics license.

Dynatrace Log Analytics extends the capabilities of the free tier of OneAgent log analysis to additionally provide central log storage, flexible retention times, and no limits on the number of retained events, analyzed logs, or log sizes.

The following example is a typical sequence of API calls for log analysis.

Fetch the list of logs. Make an API call to find out what logs are available for processing. See details on this API call for:

As a response you will receive the list of available logs.

From the response of the previous call, you know which logs are available. You can start a log analysis job for one of them. See details on this API call for:

As a response, you will receive the ID of the job.

Now that you have the ID of the analysis job, you can check the status of the job. See details on this API call for:

As a response, you will receive the information about the job: the status of the job, time stamp of last status change, any errors that occurred, and a number of processed log entries.

When the status of the log analysis job is READY, you can get the content of the log. See details on this API call for:

As a response, you will receive the records of the log.

If you have completed your analysis, delete the analysis job. You can also cancel the unfinished job with this call. See details on this API call for: