Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Logs UI] Create API route to access rare log category analysis results #42061

Closed
weltenwort opened this issue Jul 26, 2019 · 1 comment
Closed
Labels
Feature:Logs UI Logs UI feature Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services v7.4.0

Comments

@weltenwort
Copy link
Member

weltenwort commented Jul 26, 2019

Summary

This route grants access to the rare log category anomaly detection results within a given time interval.

Acceptance criteria

Request

Path: POST /api/infra/log_analysis/results/rare_log_categories

interface GetRareLogCategoriesRequest {
  data: {
    // the id of the source this job belongs to
    sourceId: string;
    timeRange: {
      // start of the requested time interval as an epoch timestamp
      startTime: number;
      // end of the requested time interval as an epoch timestamp
      endTime: number;
    };
    // the requested number of categories
    size: number;
  };
}

Responses

interface GetRareLogCategoriesSuccessResponse {
  data: {
    rareCategories: Array<{
      // the automatically generated id of the category
      categoryId: string;
      bucketBoundaries: {
        // start of the bucket as an epoch timestamp
        startTime: number;
        // end of the bucket as an epoch timestamp
        endTime: number;
      };
      // the probability of the bucket behaving like it is
      probability: number;
      // a relative measure of the anomalousness
      anomalyScore: number;
      // a set of example values from this category
      exampleValues: any[];
    }>;
  };
}

Failure conditions:

  • no matching job configured for this source: Not Found
  • insufficient permissions: Forbidden
@weltenwort weltenwort added Feature:Logs UI Logs UI feature Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services v7.4.0 labels Jul 26, 2019
@elasticmachine
Copy link
Contributor

Pinging @elastic/infra-logs-ui

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Logs UI Logs UI feature Team:Infra Monitoring UI - DEPRECATED DEPRECATED - Label for the Infra Monitoring UI team. Use Team:obs-ux-infra_services v7.4.0
Projects
None yet
Development

No branches or pull requests

3 participants