@algolia/monitoring 1.2.4 → 5.2.4-beta.2

package/dist/node.d.cts

@@ -0,0 +1,305 @@
+import * as _algolia_client_common from '@algolia/client-common';
+import { ClientOptions } from '@algolia/client-common';
+
+type BadRequest = {
+    reason?: string;
+};
+
+/**
+ * Error.
+ */
+type ErrorBase = Record<string, any> & {
+    message?: string;
+};
+
+type Forbidden = {
+    reason?: string;
+};
+
+/**
+ * Status of the cluster.
+ */
+type Status = 'degraded_performance' | 'major_outage' | 'operational' | 'partial_outage';
+
+/**
+ * Incident details.
+ */
+type Incident = {
+    /**
+     * Description of the incident.
+     */
+    title?: string;
+    status?: Status;
+};
+
+type IncidentEntry = {
+    /**
+     * Timestamp, measured in milliseconds since the Unix epoch.
+     */
+    t?: number;
+    v?: Incident;
+};
+
+type IncidentsResponse = {
+    incidents?: Record<string, IncidentEntry[]>;
+};
+
+type TimeEntry = {
+    /**
+     * Timestamp, measured in milliseconds since the Unix epoch.
+     */
+    t?: number;
+    /**
+     * Time in ms.
+     */
+    v?: number;
+};
+
+type IndexingMetric = {
+    indexing?: Record<string, TimeEntry[]>;
+};
+
+type IndexingTimeResponse = {
+    metrics?: IndexingMetric;
+};
+
+type ProbesMetric = {
+    /**
+     * Timestamp, measured in milliseconds since the Unix epoch.
+     */
+    t?: number;
+    /**
+     * Value of the metric.
+     */
+    v?: number;
+};
+
+type Metrics = {
+    /**
+     * 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[]>;
+};
+
+type InfrastructureResponse = {
+    metrics?: Metrics;
+};
+
+/**
+ * Region where the cluster is located.
+ */
+type Region = 'au' | 'br' | 'ca' | 'de' | 'eu' | 'hk' | 'in' | 'jp' | 'sg' | 'uae' | 'uk' | 'usc' | 'use' | 'usw' | 'za';
+
+type ServerStatus = 'PRODUCTION';
+
+type Type = 'cluster';
+
+type Server = {
+    /**
+     * Server name.
+     */
+    name?: string;
+    region?: Region;
+    /**
+     * Included to support legacy applications. Use `is_replica` instead.
+     */
+    is_slave?: boolean;
+    /**
+     * 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;
+};
+
+type InventoryResponse = {
+    inventory?: Server[];
+};
+
+type LatencyMetric = {
+    latency?: Record<string, TimeEntry[]>;
+};
+
+type LatencyResponse = {
+    metrics?: LatencyMetric;
+};
+
+type Metric = '*' | 'avg_build_time' | 'cpu_usage' | 'ram_indexing_usage' | 'ram_search_usage' | 'ssd_usage';
+
+type Period = 'day' | 'hour' | 'minute' | 'month' | 'week';
+
+type StatusResponse = {
+    status?: Record<string, Status>;
+};
+
+type Unauthorized = {
+    reason?: string;
+};
+
+/**
+ * Properties for the `customDelete` method.
+ */
+type CustomDeleteProps = {
+    /**
+     * 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 `customGet` method.
+ */
+type CustomGetProps = {
+    /**
+     * 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 `customPost` method.
+ */
+type CustomPostProps = {
+    /**
+     * 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, unknown>;
+};
+/**
+ * Properties for the `customPut` method.
+ */
+type CustomPutProps = {
+    /**
+     * 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, unknown>;
+};
+/**
+ * Properties for the `getClusterIncidents` method.
+ */
+type GetClusterIncidentsProps = {
+    /**
+     * Subset of clusters, separated by comma.
+     */
+    clusters: string;
+};
+/**
+ * Properties for the `getClusterStatus` method.
+ */
+type GetClusterStatusProps = {
+    /**
+     * Subset of clusters, separated by comma.
+     */
+    clusters: string;
+};
+/**
+ * Properties for the `getIndexingTime` method.
+ */
+type GetIndexingTimeProps = {
+    /**
+     * Subset of clusters, separated by comma.
+     */
+    clusters: string;
+};
+/**
+ * Properties for the `getLatency` method.
+ */
+type GetLatencyProps = {
+    /**
+     * Subset of clusters, separated by comma.
+     */
+    clusters: string;
+};
+/**
+ * Properties for the `getMetrics` method.
+ */
+type GetMetricsProps = {
+    /**
+     * Metric to report.  For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`.
+     */
+    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.
+ */
+type GetReachabilityProps = {
+    /**
+     * Subset of clusters, separated by comma.
+     */
+    clusters: string;
+};
+
+declare const apiClientVersion = "1.2.4";
+
+/**
+ * The client type.
+ */
+type MonitoringClient = ReturnType<typeof monitoringClient>;
+declare function monitoringClient(appId: string, apiKey: string, options?: ClientOptions): {
+    transporter: _algolia_client_common.Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    _ua: string;
+    addAlgoliaAgent(segment: string, version?: string): void;
+    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customGet({ path, parameters }: CustomGetProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    getClusterIncidents({ clusters }: GetClusterIncidentsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<IncidentsResponse>;
+    getClusterStatus({ clusters }: GetClusterStatusProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<StatusResponse>;
+    getIncidents(requestOptions?: _algolia_client_common.RequestOptions): Promise<IncidentsResponse>;
+    getIndexingTime({ clusters }: GetIndexingTimeProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<IndexingTimeResponse>;
+    getLatency({ clusters }: GetLatencyProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<LatencyResponse>;
+    getMetrics({ metric, period }: GetMetricsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<InfrastructureResponse>;
+    getReachability({ clusters }: GetReachabilityProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, Record<string, boolean>>>;
+    getServers(requestOptions?: _algolia_client_common.RequestOptions): Promise<InventoryResponse>;
+    getStatus(requestOptions?: _algolia_client_common.RequestOptions): Promise<StatusResponse>;
+};
+
+export { type BadRequest, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type ErrorBase, type Forbidden, type GetClusterIncidentsProps, type GetClusterStatusProps, type GetIndexingTimeProps, type GetLatencyProps, type GetMetricsProps, type GetReachabilityProps, type Incident, type IncidentEntry, type IncidentsResponse, type IndexingMetric, type IndexingTimeResponse, type InfrastructureResponse, type InventoryResponse, type LatencyMetric, type LatencyResponse, type Metric, type Metrics, type MonitoringClient, type Period, type ProbesMetric, type Region, type Server, type ServerStatus, type Status, type StatusResponse, type TimeEntry, type Type, type Unauthorized, apiClientVersion, monitoringClient };

package/dist/node.d.ts

@@ -0,0 +1,305 @@
+import * as _algolia_client_common from '@algolia/client-common';
+import { ClientOptions } from '@algolia/client-common';
+
+type BadRequest = {
+    reason?: string;
+};
+
+/**
+ * Error.
+ */
+type ErrorBase = Record<string, any> & {
+    message?: string;
+};
+
+type Forbidden = {
+    reason?: string;
+};
+
+/**
+ * Status of the cluster.
+ */
+type Status = 'degraded_performance' | 'major_outage' | 'operational' | 'partial_outage';
+
+/**
+ * Incident details.
+ */
+type Incident = {
+    /**
+     * Description of the incident.
+     */
+    title?: string;
+    status?: Status;
+};
+
+type IncidentEntry = {
+    /**
+     * Timestamp, measured in milliseconds since the Unix epoch.
+     */
+    t?: number;
+    v?: Incident;
+};
+
+type IncidentsResponse = {
+    incidents?: Record<string, IncidentEntry[]>;
+};
+
+type TimeEntry = {
+    /**
+     * Timestamp, measured in milliseconds since the Unix epoch.
+     */
+    t?: number;
+    /**
+     * Time in ms.
+     */
+    v?: number;
+};
+
+type IndexingMetric = {
+    indexing?: Record<string, TimeEntry[]>;
+};
+
+type IndexingTimeResponse = {
+    metrics?: IndexingMetric;
+};
+
+type ProbesMetric = {
+    /**
+     * Timestamp, measured in milliseconds since the Unix epoch.
+     */
+    t?: number;
+    /**
+     * Value of the metric.
+     */
+    v?: number;
+};
+
+type Metrics = {
+    /**
+     * 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[]>;
+};
+
+type InfrastructureResponse = {
+    metrics?: Metrics;
+};
+
+/**
+ * Region where the cluster is located.
+ */
+type Region = 'au' | 'br' | 'ca' | 'de' | 'eu' | 'hk' | 'in' | 'jp' | 'sg' | 'uae' | 'uk' | 'usc' | 'use' | 'usw' | 'za';
+
+type ServerStatus = 'PRODUCTION';
+
+type Type = 'cluster';
+
+type Server = {
+    /**
+     * Server name.
+     */
+    name?: string;
+    region?: Region;
+    /**
+     * Included to support legacy applications. Use `is_replica` instead.
+     */
+    is_slave?: boolean;
+    /**
+     * 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;
+};
+
+type InventoryResponse = {
+    inventory?: Server[];
+};
+
+type LatencyMetric = {
+    latency?: Record<string, TimeEntry[]>;
+};
+
+type LatencyResponse = {
+    metrics?: LatencyMetric;
+};
+
+type Metric = '*' | 'avg_build_time' | 'cpu_usage' | 'ram_indexing_usage' | 'ram_search_usage' | 'ssd_usage';
+
+type Period = 'day' | 'hour' | 'minute' | 'month' | 'week';
+
+type StatusResponse = {
+    status?: Record<string, Status>;
+};
+
+type Unauthorized = {
+    reason?: string;
+};
+
+/**
+ * Properties for the `customDelete` method.
+ */
+type CustomDeleteProps = {
+    /**
+     * 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 `customGet` method.
+ */
+type CustomGetProps = {
+    /**
+     * 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 `customPost` method.
+ */
+type CustomPostProps = {
+    /**
+     * 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, unknown>;
+};
+/**
+ * Properties for the `customPut` method.
+ */
+type CustomPutProps = {
+    /**
+     * 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, unknown>;
+};
+/**
+ * Properties for the `getClusterIncidents` method.
+ */
+type GetClusterIncidentsProps = {
+    /**
+     * Subset of clusters, separated by comma.
+     */
+    clusters: string;
+};
+/**
+ * Properties for the `getClusterStatus` method.
+ */
+type GetClusterStatusProps = {
+    /**
+     * Subset of clusters, separated by comma.
+     */
+    clusters: string;
+};
+/**
+ * Properties for the `getIndexingTime` method.
+ */
+type GetIndexingTimeProps = {
+    /**
+     * Subset of clusters, separated by comma.
+     */
+    clusters: string;
+};
+/**
+ * Properties for the `getLatency` method.
+ */
+type GetLatencyProps = {
+    /**
+     * Subset of clusters, separated by comma.
+     */
+    clusters: string;
+};
+/**
+ * Properties for the `getMetrics` method.
+ */
+type GetMetricsProps = {
+    /**
+     * Metric to report.  For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`.
+     */
+    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.
+ */
+type GetReachabilityProps = {
+    /**
+     * Subset of clusters, separated by comma.
+     */
+    clusters: string;
+};
+
+declare const apiClientVersion = "1.2.4";
+
+/**
+ * The client type.
+ */
+type MonitoringClient = ReturnType<typeof monitoringClient>;
+declare function monitoringClient(appId: string, apiKey: string, options?: ClientOptions): {
+    transporter: _algolia_client_common.Transporter;
+    appId: string;
+    clearCache(): Promise<void>;
+    _ua: string;
+    addAlgoliaAgent(segment: string, version?: string): void;
+    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customGet({ path, parameters }: CustomGetProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
+    getClusterIncidents({ clusters }: GetClusterIncidentsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<IncidentsResponse>;
+    getClusterStatus({ clusters }: GetClusterStatusProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<StatusResponse>;
+    getIncidents(requestOptions?: _algolia_client_common.RequestOptions): Promise<IncidentsResponse>;
+    getIndexingTime({ clusters }: GetIndexingTimeProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<IndexingTimeResponse>;
+    getLatency({ clusters }: GetLatencyProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<LatencyResponse>;
+    getMetrics({ metric, period }: GetMetricsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<InfrastructureResponse>;
+    getReachability({ clusters }: GetReachabilityProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, Record<string, boolean>>>;
+    getServers(requestOptions?: _algolia_client_common.RequestOptions): Promise<InventoryResponse>;
+    getStatus(requestOptions?: _algolia_client_common.RequestOptions): Promise<StatusResponse>;
+};
+
+export { type BadRequest, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type ErrorBase, type Forbidden, type GetClusterIncidentsProps, type GetClusterStatusProps, type GetIndexingTimeProps, type GetLatencyProps, type GetMetricsProps, type GetReachabilityProps, type Incident, type IncidentEntry, type IncidentsResponse, type IndexingMetric, type IndexingTimeResponse, type InfrastructureResponse, type InventoryResponse, type LatencyMetric, type LatencyResponse, type Metric, type Metrics, type MonitoringClient, type Period, type ProbesMetric, type Region, type Server, type ServerStatus, type Status, type StatusResponse, type TimeEntry, type Type, type Unauthorized, apiClientVersion, monitoringClient };