@algolia/monitoring 1.0.0-alpha.3

package/model/clientMethodProps.ts

@@ -0,0 +1,132 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { Metric } from './metric';
+import type { Period } from './period';
+
+/**
+ * Properties for the `del` method.
+ */
+export type DelProps = {
+  /**
+   * Path of the endpoint, anything after \"/1\" must be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `get` method.
+ */
+export type GetProps = {
+  /**
+   * Path of the endpoint, anything after \"/1\" must be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
+};
+
+/**
+ * Properties for the `getClusterIncidents` method.
+ */
+export type GetClusterIncidentsProps = {
+  /**
+   * Subset of clusters, separated by comma.
+   */
+  clusters: string;
+};
+
+/**
+ * Properties for the `getClusterStatus` method.
+ */
+export type GetClusterStatusProps = {
+  /**
+   * Subset of clusters, separated by comma.
+   */
+  clusters: string;
+};
+
+/**
+ * Properties for the `getIndexingTime` method.
+ */
+export type GetIndexingTimeProps = {
+  /**
+   * Subset of clusters, separated by comma.
+   */
+  clusters: string;
+};
+
+/**
+ * Properties for the `getLatency` method.
+ */
+export type GetLatencyProps = {
+  /**
+   * Subset of clusters, separated by comma.
+   */
+  clusters: string;
+};
+
+/**
+ * Properties for the `getMetrics` method.
+ */
+export type GetMetricsProps = {
+  /**
+   * Metric to report.  For more information about the individual metrics, see the response. To include all metrics, use `*` as the parameter.
+   */
+  metric: Metric;
+  /**
+   * Period over which to aggregate the metrics:  - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day.
+   */
+  period: Period;
+};
+
+/**
+ * Properties for the `getReachability` method.
+ */
+export type GetReachabilityProps = {
+  /**
+   * Subset of clusters, separated by comma.
+   */
+  clusters: string;
+};
+
+/**
+ * Properties for the `post` method.
+ */
+export type PostProps = {
+  /**
+   * Path of the endpoint, anything after \"/1\" must be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * Parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};
+
+/**
+ * Properties for the `put` method.
+ */
+export type PutProps = {
+  /**
+   * Path of the endpoint, anything after \"/1\" must be specified.
+   */
+  path: string;
+  /**
+   * Query parameters to apply to the current query.
+   */
+  parameters?: Record<string, any>;
+  /**
+   * Parameters to send with the custom request.
+   */
+  body?: Record<string, any>;
+};

package/model/errorBase.ts

@@ -0,0 +1,8 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+/**
+ * Error.
+ */
+export type ErrorBase = Record<string, any> & {
+  message?: string;
+};

package/model/getInventory403Response.ts

@@ -0,0 +1,5 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type GetInventory403Response = {
+  reason?: string;
+};

package/model/incident.ts

@@ -0,0 +1,15 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { Status } from './status';
+
+/**
+ * Incident details.
+ */
+export type Incident = {
+  /**
+   * Description of the incident.
+   */
+  title?: string;
+
+  status?: Status;
+};

package/model/incidentsInner.ts

@@ -0,0 +1,12 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { Incident } from './incident';
+
+export type IncidentsInner = {
+  /**
+   * Timestamp in [Unix epoch time](https://wikipedia.org/wiki/Unix_time) in milliseconds.
+   */
+  t?: number;
+
+  v?: Incident;
+};

package/model/incidentsResponse.ts

@@ -0,0 +1,7 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { IncidentsInner } from './incidentsInner';
+
+export type IncidentsResponse = {
+  incidents?: Record<string, IncidentsInner[]>;
+};

package/model/index.ts

@@ -0,0 +1,25 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export * from './errorBase';
+export * from './getInventory403Response';
+export * from './incident';
+export * from './incidentsInner';
+export * from './incidentsResponse';
+export * from './indexingTimeResponse';
+export * from './indexingTimeResponseMetrics';
+export * from './infrastructureResponse';
+export * from './infrastructureResponseMetrics';
+export * from './inventoryResponse';
+export * from './latencyResponse';
+export * from './latencyResponseMetrics';
+export * from './metric';
+export * from './period';
+export * from './probesMetric';
+export * from './region';
+export * from './server';
+export * from './serverStatus';
+export * from './status';
+export * from './statusResponse';
+export * from './timeInner';
+export * from './type';
+export * from './clientMethodProps';

package/model/indexingTimeResponse.ts

@@ -0,0 +1,7 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { IndexingTimeResponseMetrics } from './indexingTimeResponseMetrics';
+
+export type IndexingTimeResponse = {
+  metrics?: IndexingTimeResponseMetrics;
+};

package/model/indexingTimeResponseMetrics.ts

@@ -0,0 +1,7 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { TimeInner } from './timeInner';
+
+export type IndexingTimeResponseMetrics = {
+  indexing?: Record<string, TimeInner[]>;
+};

package/model/infrastructureResponse.ts

@@ -0,0 +1,7 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { InfrastructureResponseMetrics } from './infrastructureResponseMetrics';
+
+export type InfrastructureResponse = {
+  metrics?: InfrastructureResponseMetrics;
+};

package/model/infrastructureResponseMetrics.ts

@@ -0,0 +1,30 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { ProbesMetric } from './probesMetric';
+
+export type InfrastructureResponseMetrics = {
+  /**
+   * CPU idleness in %.
+   */
+  cpu_usage?: Record<string, ProbesMetric[]>;
+
+  /**
+   * RAM used for indexing in MB.
+   */
+  ram_indexing_usage?: Record<string, ProbesMetric[]>;
+
+  /**
+   * RAM used for search in MB.
+   */
+  ram_search_usage?: Record<string, ProbesMetric[]>;
+
+  /**
+   * Solid-state disk (SSD) usage expressed as % of RAM.  0% means no SSD usage. A value of 50% indicates 32&nbsp;GB SSD usage for a machine with 64&nbsp;RAM.
+   */
+  ssd_usage?: Record<string, ProbesMetric[]>;
+
+  /**
+   * Average build time of the indices in seconds.
+   */
+  avg_build_time?: Record<string, ProbesMetric[]>;
+};

package/model/inventoryResponse.ts

@@ -0,0 +1,7 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { Server } from './server';
+
+export type InventoryResponse = {
+  inventory?: Server[];
+};

package/model/latencyResponse.ts

@@ -0,0 +1,7 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { LatencyResponseMetrics } from './latencyResponseMetrics';
+
+export type LatencyResponse = {
+  metrics?: LatencyResponseMetrics;
+};

package/model/latencyResponseMetrics.ts

@@ -0,0 +1,7 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { TimeInner } from './timeInner';
+
+export type LatencyResponseMetrics = {
+  latency?: Record<string, TimeInner[]>;
+};

package/model/metric.ts

@@ -0,0 +1,9 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type Metric =
+  | '*'
+  | 'avg_build_time'
+  | 'cpu_usage'
+  | 'ram_indexing_usage'
+  | 'ram_search_usage'
+  | 'ssd_usage';

package/model/period.ts

@@ -0,0 +1,3 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type Period = 'day' | 'hour' | 'minute' | 'month' | 'week';

package/model/probesMetric.ts

@@ -0,0 +1,13 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type ProbesMetric = {
+  /**
+   * Timestamp in [Unix epoch time](https://wikipedia.org/wiki/Unix_time) in milliseconds.
+   */
+  t?: number;
+
+  /**
+   * Value of the metric.
+   */
+  v?: number;
+};

package/model/region.ts

@@ -0,0 +1,21 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+/**
+ * The region where the cluster is located.
+ */
+export type Region =
+  | 'au'
+  | 'br'
+  | 'ca'
+  | 'de'
+  | 'eu'
+  | 'hk'
+  | 'in'
+  | 'jp'
+  | 'sg'
+  | 'uae'
+  | 'uk'
+  | 'usc'
+  | 'use'
+  | 'usw'
+  | 'za';

package/model/server.ts

@@ -0,0 +1,33 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { Region } from './region';
+import type { ServerStatus } from './serverStatus';
+import type { Type } from './type';
+
+export type Server = {
+  /**
+   * Server name.
+   */
+  name?: string;
+
+  region?: Region;
+
+  /**
+   * Included to support legacy applications. Do not rely on this attribute being present in the response. Use `is_replica` instead.
+   */
+  is_slave?: boolean;
+
+  /**
+   * Indicates whether this server is a replica of another server.
+   */
+  is_replica?: boolean;
+
+  /**
+   * Name of the cluster to which this server belongs.
+   */
+  cluster?: string;
+
+  status?: ServerStatus;
+
+  type?: Type;
+};

package/model/serverStatus.ts

@@ -0,0 +1,3 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type ServerStatus = 'PRODUCTION';

package/model/status.ts

@@ -0,0 +1,10 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+/**
+ * Status of the cluster.
+ */
+export type Status =
+  | 'degraded_performance'
+  | 'major_outage'
+  | 'operational'
+  | 'partial_outage';

package/model/statusResponse.ts

@@ -0,0 +1,7 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { Status } from './status';
+
+export type StatusResponse = {
+  status?: Record<string, Status>;
+};

package/model/timeInner.ts

@@ -0,0 +1,13 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type TimeInner = {
+  /**
+   * Timestamp in [Unix epoch time](https://wikipedia.org/wiki/Unix_time) in milliseconds.
+   */
+  t?: number;
+
+  /**
+   * Time in ms.
+   */
+  v?: number;
+};

package/model/type.ts

@@ -0,0 +1,3 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+export type Type = 'cluster';

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@algolia/monitoring",
+  "version": "1.0.0-alpha.3",
+  "description": "JavaScript client for monitoring",
+  "repository": "algolia/algoliasearch-client-javascript",
+  "license": "MIT",
+  "author": "Algolia",
+  "type": "module",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/monitoring.esm.node.js",
+        "module": "./dist/monitoring.esm.node.js",
+        "require": "./dist/monitoring.cjs.js",
+        "default": "./dist/monitoring.cjs.js"
+      },
+      "default": {
+        "umd": "./dist/monitoring.umd.js",
+        "module": "./dist/monitoring.esm.browser.js",
+        "import": "./dist/monitoring.esm.browser.js",
+        "default": "./dist/monitoring.umd.js"
+      }
+    },
+    "./src/*": "./src/*.ts",
+    "./model": "./model/index.ts"
+  },
+  "jsdelivr": "./dist/monitoring.umd.js",
+  "unpkg": "./dist/monitoring.umd.js",
+  "browser": "./dist/monitoring.umd.js",
+  "types": "./index.d.ts",
+  "files": [
+    "dist",
+    "model",
+    "index.js",
+    "index.d.ts"
+  ],
+  "scripts": {
+    "build": "yarn clean && rollup --config",
+    "clean": "rm -rf ./dist || true"
+  },
+  "dependencies": {
+    "@algolia/client-common": "5.0.0-alpha.75",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.75",
+    "@algolia/requester-node-http": "5.0.0-alpha.75"
+  },
+  "devDependencies": {
+    "@types/node": "18.17.0",
+    "rollup": "3.26.3",
+    "typescript": "5.1.6"
+  },
+  "engines": {
+    "node": ">= 14.0.0"
+  }
+}