logo
Doom
English
简体中文
English
简体中文
logo
Doom
Introduction
Getting Started

Usage

Configuration
Convention
Markdown
MDX
Internationalization
API Documentation
Permission Description Document
Referencing Documents
Deployment

APIs

Advanced API

Event APIs

Search

Log APIs

Aggregation
Search
CodeQualityTaskSummary
Projects

Workload APIs

DaemonSet [apps/v1]
Deployments [apps/v1]

CRDs

ArtifactCleanupRun

Public References

CodeQuality
CodeQualityBranch
📝 Edit this page on GitHub
Previous PageLog APIs
Next PageSearch

#Aggregation

/platform/logging.alauda.io/v2/logs/aggregation#

getLog Aggregation#

Aggregate logs into buckets for chart display with authentication.

Parameters#

  • buckets (in query): integer

    Number of buckets for aggregation. Default is 30.

  • start (in query): number required

    Start time of the time range.

  • end (in query): number required

    End time of the time range.

  • cluster (in query): string required

    Name of the cluster.

  • logType (in query): string

    Type of log. Options: system, platform, kubernetes, workload. Default is workload.

  • projects (in query): string

    Project names for application logs, comma separated.

  • namespaces (in query): string

    Namespace names for application logs, comma separated.

  • workloads (in query): string

    Workload type and name pairs for application logs, e.g., Deployment:lanaya. Multiple values separated by commas.

  • podNames (in query): string

    Pod names, comma separated.

  • containerNames (in query): string

    Container names, comma separated.

  • nodes (in query): string

    Node names, comma separated.

  • paths (in query): string

    Path names, comma separated.

  • products (in query): string

    Product names for product logs, comma separated.

  • components (in query): string

    Component names for product logs or Kubernetes logs, comma separated.

  • query (in query): string

    Query keywords, supports AND, OR, and escape with backslash.

Response#

  • 200object: Successful aggregation response
    Properties:
    • buckets: []Bucket

Bucket#

  • time: number
  • count: integer

/platform/logging.alauda.io/v2/clusters/{cluster}/logs/aggregation#

getLog Aggregation by Cluster#

Aggregate logs by cluster into buckets with authentication.

Parameters#

  • cluster (in path): string required

    Name of the cluster.

  • buckets (in query): integer

    Number of buckets for aggregation. Default is 30.

  • start (in query): number required

    Start time of the time range.

  • end (in query): number required

    End time of the time range.

  • logType (in query): string

    Type of log. Options: system, platform, kubernetes, workload. Default is workload.

  • projects (in query): string

    Project names for application logs, comma separated.

  • namespaces (in query): string

    Namespace names for application logs, comma separated.

  • workloads (in query): string

    Workload type and name pairs for application logs, e.g., Deployment:lanaya. Multiple values separated by commas.

  • podNames (in query): string

    Pod names, comma separated.

  • containerNames (in query): string

    Container names, comma separated.

  • nodes (in query): string

    Node names, comma separated.

  • paths (in query): string

    Path names, comma separated.

  • products (in query): string

    Product names for product logs, comma separated.

  • components (in query): string

    Component names for product logs or Kubernetes logs, comma separated.

  • query (in query): string

    Query keywords, supports AND, OR, and escape with backslash.

Response#

  • 200object: Successful aggregation response
    Properties:
    • buckets: []Bucket

Bucket#

  • time: number
  • count: integer

/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/aggregation#

getLog Aggregation by Project, Cluster and Namespace#

Aggregate logs within a specific project, cluster, and namespace into buckets with authentication.

Parameters#

  • project (in path): string required

    Name of the project.

  • cluster (in path): string required

    Name of the cluster.

  • namespace (in path): string required

    Name of the namespace.

  • buckets (in query): integer

    Number of buckets for aggregation. Default is 30.

  • start (in query): number required

    Start time of the time range.

  • end (in query): number required

    End time of the time range.

  • logType (in query): string

    Type of log. Options: system, platform, kubernetes, workload. Default is workload.

  • workloads (in query): string

    Workload type and name pairs for application logs, e.g., Deployment:lanaya. Multiple values separated by commas.

  • podNames (in query): string

    Pod names, comma separated.

  • containerNames (in query): string

    Container names, comma separated.

  • namespaces (in query): string

    Namespace names for application logs, comma separated.

  • nodes (in query): string

    Node names, comma separated.

  • paths (in query): string

    Path names, comma separated.

  • products (in query): string

    Product names for product logs, comma separated.

  • components (in query): string

    Component names for product logs or Kubernetes logs, comma separated.

  • query (in query): string

    Query keywords, supports AND, OR, and escape with backslash.

Response#

  • 200object: Successful aggregation response
    Properties:
    • buckets: []Bucket

Bucket#

  • time: number
  • count: integer