@dynatrace-sdk/client-classic-environment-v2 5.2.3 → 6.1.0

package/types/packages/client/classic-environment-v2/src/lib/apis/index.d.ts

@@ -1,34 +0,0 @@
-export * from './access-tokens-active-gate-tokens-api';
-export * from './access-tokens-agent-tokens-api';
-export * from './access-tokens-api-tokens-api';
-export * from './access-tokens-tenant-tokens-api';
-export * from './active-gates-active-gate-groups-api';
-export * from './active-gates-api';
-export * from './active-gates-auto-update-configuration-api';
-export * from './active-gates-auto-update-jobs-api';
-export * from './attacks-api';
-export * from './audit-logs-api';
-export * from './business-events-api';
-export * from './credential-vault-api';
-export * from './davis-security-advisor-api';
-export * from './events-api';
-export * from './extensions-2-0-api';
-export * from './logs-api';
-export * from './metrics-api';
-export * from './metrics-units-api';
-export * from './monitored-entities-api';
-export * from './monitored-entities-custom-tags-api';
-export * from './monitored-entities-monitoring-state-api';
-export * from './network-zones-api';
-export * from './problems-api';
-export * from './releases-api';
-export * from './rum-manual-insertion-tags-api';
-export * from './security-problems-api';
-export * from './service-level-objectives-api';
-export * from './settings-management-zones-api';
-export * from './settings-objects-api';
-export * from './settings-schemas-api';
-export * from './synthetic-http-monitor-executions-api';
-export * from './synthetic-locations-nodes-and-configuration-api';
-export * from './synthetic-network-availability-monitors-api';
-export * from './synthetic-on-demand-monitor-executions-api';

package/types/packages/client/classic-environment-v2/src/lib/apis/logs-api.d.ts

@@ -1,401 +0,0 @@
-import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
-import { AggregatedLog } from '../models/aggregated-log';
-import { ExportedLogRecordList } from '../models/exported-log-record-list';
-import { LogMessageJson } from '../models/log-message-json';
-import { LogMessagePlain } from '../models/log-message-plain';
-import { LogRecordsList } from '../models/log-records-list';
-import { SuccessEnvelope } from '../models/success-envelope';
-import { ApiClientOptions } from './api-client-options';
-/**
- * Read and ingest logs
- */
-export declare class LogsClient {
-    private httpClient;
-    private shouldTransformDates;
-    /**
-     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a LogsClient. Custom http client should implement {HttpClient} interface.
-     * @param {ApiClientOptions} [options] - Optional configuration for SDK Client.
-     * @example
-     * const logsClientNodeJs = new LogsClient(yourCustomImplementation);
-     */
-    constructor(httpClientImplementation: HttpClient, options?: ApiClientOptions);
-    /**
-     * Gets aggregated log records | maturity=EARLY_ADOPTER
-     *
-     * **Required scope:** storage:logs:read<br/>**One of the following permissions is required:**
-     * + environment:roles:logviewer
-     * + storage:logs:read
-     *
-     * <br/><br/>Returns the aggregated number of occurrences of log values divided into time slots.
-     *
-     * It is possible that the timeframe covered by results exceeds the specified timeframe. In that case the request returns fewer time slots than specified in the **timeBuckets** query parameter.
-     *
-     *
-     *
-     * If *Log Management and Analytics, powered by Grail* is enabled,
-     * then a bearer OAuth token (with `storage:logs:read` and `storage:buckets:read` scopes)
-     * needs to be used for authentication.
-     *
-     * Please note that *Dynatrace API explorer* does not currently support OAuth authentication.
-     *
-     * <br>
-     * **Logs on Grail:**
-     * <br>
-     * It is **not** recommended to run Grail queries using Logs v2 API, please use Grail API instead.
-     *
-     * @returns {Promise<AggregatedLog>} Success
-     *
-     * @example <caption>Code example</caption>
-     * import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await logsClient.getLogHistogramData();
-     *
-     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    getLogHistogramData(config?: {
-        /**
-         * The start of the requested timeframe.
-         *
-         * You can use one of the following formats:
-         * * Timestamp in UTC milliseconds.
-         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
-         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
-         * You can also specify relative timeframe without an alignment: `now-NU`.
-         * Supported time units for the relative timeframe are:
-         *    * `m`: minutes
-         *    * `h`: hours
-         *    * `d`: days
-         *    * `w`: weeks
-         *    * `M`: months
-         *    * `y`: years
-         *
-         * If not set, the relative timeframe of two weeks is used (`now-2w`).
-         */ from?: string;
-        /**
-         * The end of the requested timeframe.
-         *
-         * You can use one of the following formats:
-         * * Timestamp in UTC milliseconds.
-         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
-         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
-         * You can also specify relative timeframe without an alignment: `now-NU`.
-         * Supported time units for the relative timeframe are:
-         *    * `m`: minutes
-         *    * `h`: hours
-         *    * `d`: days
-         *    * `w`: weeks
-         *    * `M`: months
-         *    * `y`: years
-         *
-         * If not set, the current timestamp is used.
-         */ to?: string;
-        /**
-         * The log search query.
-         *
-         * The query must use the [Dynatrace search query language](https://dt-url.net/pe03s6f).
-         */ query?: string;
-        /**
-         * The number of time slots in the result.
-         *
-         * The query timeframe is divided equally into the specified number of slots.
-         *
-         * The minimum length of a slot is 1 ms.
-         *
-         * If not set, 1 is used.
-         */ timeBuckets?: number;
-        /**
-         * The maximum number of values in each group.
-         *
-         * You can get up to 100 values per group.
-         *
-         * If not set, 10 is used.
-         */ maxGroupValues?: number;
-        /**
-         * The groupings to be included in the response.
-         *
-         * You can specify several groups in the following format: `groupBy=status&groupBy=log.source`.
-         *
-         * If not set, all possible groups are returned. You can use this option to check for possible grouping values.
-         *
-         * Unique log data attributes (high-cardinality attributes) for example, `span_id` or `trace_id` cannot be used for grouping.
-         */ groupBy?: string[];
-        abortSignal?: AbortSignal;
-    }): Promise<AggregatedLog>;
-    /**
-     * Exports log records | maturity=EARLY_ADOPTER
-     *
-     * **Required scope:** storage:logs:read<br/>**One of the following permissions is required:**
-     * + environment:roles:logviewer
-     * + storage:logs:read
-     *
-     * <br/><br/>Returns the first *X* records (specified in the **pageSize** query parameter).
-     *
-     *  Unlike the **search** API, this API does not split the result into slices and has no limit for the total number of records. Log records are sorted by the criteria specified in the **sort** query parameter.
-     *
-     *  In order to fetch large amount of records (exceeding the **pageSize** value), one should repeat the **export** call with **nextPageKey** param.
-     *
-     * <br>Please note that export works **only** for *Logs Classic*.
-     *
-     * @returns {Promise<ExportedLogRecordList>} Success
-     *
-     * @example <caption>Code example</caption>
-     * import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await logsClient.exportLogRecords();
-     *
-     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. The server either does not recognize the request method, or it lacks the ability to fulfill the request. May happen when Grail log storage is enabled. | Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    exportLogRecords(config?: {
-        /**
-         * The start of the requested timeframe.
-         *
-         * You can use one of the following formats:
-         * * Timestamp in UTC milliseconds.
-         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
-         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
-         * You can also specify relative timeframe without an alignment: `now-NU`.
-         * Supported time units for the relative timeframe are:
-         *    * `m`: minutes
-         *    * `h`: hours
-         *    * `d`: days
-         *    * `w`: weeks
-         *    * `M`: months
-         *    * `y`: years
-         *
-         * If not set, the relative timeframe of two weeks is used (`now-2w`).
-         */ from?: string;
-        /**
-         * The end of the requested timeframe.
-         *
-         * You can use one of the following formats:
-         * * Timestamp in UTC milliseconds.
-         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
-         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
-         * You can also specify relative timeframe without an alignment: `now-NU`.
-         * Supported time units for the relative timeframe are:
-         *    * `m`: minutes
-         *    * `h`: hours
-         *    * `d`: days
-         *    * `w`: weeks
-         *    * `M`: months
-         *    * `y`: years
-         *
-         * If not set, the current timestamp is used.
-         */ to?: string;
-        /**
-         * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
-         *
-         * The first page is always returned if you don't specify the **nextPageKey** query parameter.
-         *
-         * When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters.
-         */ nextPageKey?: string;
-        /** The number of results per result page. */ pageSize?: number;
-        /**
-         * The log search query.
-         *
-         * The query must use the [Dynatrace search query language](https://dt-url.net/pe03s6f).
-         */ query?: string;
-        /**
-         * Defines the ordering of the log records.
-         *
-         * Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the `+` option will be applied.
-         *
-         * Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).
-         *
-         * When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).
-         */ sort?: string;
-        abortSignal?: AbortSignal;
-    }): Promise<ExportedLogRecordList>;
-    /**
-     * Pushes log records to Dynatrace
-     *
-     * **Required scope:** storage:logs:write<br/>**Required permission:** storage:logs:write<br/><br/>Ingested logs are stored in the indexed log storage.
-     *
-     * This endpoint requires an ActiveGate with the **Log Analytics Collector** module enabled.
-     *
-     * **High-cardinality attributes:**
-     *
-     * Unique log data attributes (high-cardinality attributes) such as `span_id` and `trace_id` generate unnecessarily excessive facet lists that may impact log viewer performance. Because of this, they aren't listed in log viewer facets. You can still use them in a log viewer advanced search query.
-     *
-     * <br />**Limitations:**
-     *
-     * Please refer to the following documentation pages:
-     *  * [Grail tenant limits](https://docs.dynatrace.com/docs/analyze-explore-automate/logs/lma-limits)
-     *  * [LM v2 SaaS tenant limits](https://docs.dynatrace.com/docs/analyze-explore-automate/log-monitoring/log-monitoring-limits)
-     *  * [LM v2 Managed tenant limits](https://docs.dynatrace.com/managed/analyze-explore-automate/log-monitoring/log-monitoring-limits)
-     *
-     * <br />**Error handling:**
-     *
-     * The following HTTP status codes are considered retryable:
-     *
-     *  * 429 Too Many Requests
-     *  * 502 Bad Gateway
-     *  * 503 Service Unavailable
-     *  * 504 Gateway Timeout
-     *
-     * It is recommended to use an exponential backoff strategy for retrying requests.
-     *
-     * @returns {Promise<SuccessEnvelope | void>} Only a part of input events were ingested due to event invalidity. For details, check the response body.
-     *
-     * @example <caption>Code example</caption>
-     * import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await logsClient.storeLog({
-     *   type: "application/json",
-     *   body: [
-     *     {
-     *       content:
-     *         "Exception: Custom error log sent via Generic Log Ingest",
-     *       "log.source": "/var/log/syslog",
-     *       timestamp: "2022-01-17T22:12:31.0000",
-     *       severity: "error",
-     *       "custom.attribute": "attribute value",
-     *     },
-     *     {
-     *       content:
-     *         "Exception: Custom error log sent via Generic Log Ingest",
-     *       "log.source": "/var/log/syslog",
-     *       timestamp: "2022-01-17T22:12:35.0000",
-     *     },
-     *     {
-     *       content:
-     *         "Exception: Custom error log sent via Generic Log Ingest",
-     *       "log.source": "/var/log/syslog",
-     *     },
-     *     {
-     *       content:
-     *         "Exception: Custom error log sent via Generic Log Ingest",
-     *     },
-     *   ],
-     * });
-     *
-     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. This is due either to the status of your licensing agreement or because you've exhausted your [DPS license](https://www.dynatrace.com/support/help/shortlink/dynatrace-platform-subscription). | Failed. The requested resource doesn't exist. This may happen when no ActiveGate is available with the Log Analytics Collector module enabled. | Failed. Request payload size is too big. This may happen when the payload byte size exceeds the limit or when the ingested payload is a JSON array with the size exceeding the limit. | Failed. Too Many Requests. This may happen when ActiveGate is unable to process more requests at the moment or when log ingest is disabled. Retryable with exponential backoff strategy. | Failed. The server either does not recognize the request method, or it lacks the ability to fulfil the request. In Log Monitoring Classic, this may happen when indexed log storage is not enabled. | Failed. The server is currently unable to handle the request. This may happen when ActiveGate is overloaded. Retryable with exponential backoff strategy. | Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    storeLog(config: ({
-        body: LogMessageJson;
-        type: 'application/json' | 'application/json; charset=utf-8' | 'application/jsonl' | 'application/jsonl; charset=utf-8' | 'application/jsonlines' | 'application/jsonlines+json' | 'application/jsonlines+json; charset=utf-8' | 'application/jsonlines; charset=utf-8' | 'application/x-jsonlines' | 'application/x-jsonlines; charset=utf-8' | 'application/x-ndjson' | 'application/x-ndjson; charset=utf-8';
-    } | {
-        body: LogMessagePlain;
-        type: 'text/plain; charset=utf-8';
-    }) & {
-        /** Specifies the JSON parsing mode for log ingestion (SaaS only). For more details, refer to the [documentation](https://dt-url.net/rl03zti). */ structure?: 'flattened' | 'raw';
-        /** Allows to provide content type with query parameter. Has priority over value provided in Content-Type header. */ contentType?: string;
-        /** (Optional) Contains ampersand-separated Dynatrace-specific parameters. Query parameter takes precedence over the header value. For more details, refer to the [documentation](https://dt-url.net/rl03zti). */ xDynatraceOptions?: string;
-        abortSignal?: AbortSignal;
-    }): Promise<SuccessEnvelope | void>;
-    /**
-     * Reads log records | maturity=EARLY_ADOPTER
-     *
-     * **Required scope:** storage:logs:read<br/>**One of the following permissions is required:**
-     * + environment:roles:logviewer
-     * + storage:logs:read
-     *
-     * <br/><br/>Returns the first *X* records (specified in the **limit** query parameter). Log records are sorted by the criteria specified in the **sort** query parameter.
-     *
-     * If the query is too large to be processed in a single request, it is divided into slices (slices are unsupported on *Log Management and Analytics, powered by Grail*). In that case the first response contains the **nextSliceKey** cursor for the second slice. Use it in the **nextSliceKey** query parameter to obtain the second slice, which contains **nextSliceKey** cursor for the third slice, and so on.
-     *
-     * Results can be distributed unevenly between slices and some slices might be empty.
-     *
-     * If *Log Management and Analytics, powered by Grail* is enabled,
-     * then a bearer OAuth token (with `storage:logs:read` and `storage:buckets:read` scopes)
-     * needs to be used for authentication.
-     *
-     * Please note that *Dynatrace API explorer* does not currently support OAuth authentication.
-     *
-     * <br>
-     * **Logs on Grail:**
-     * <br>
-     * It is **not** recommended to run Grail queries using Logs v2 API, please use Grail API instead.
-     *
-     * @returns {Promise<LogRecordsList>} Success
-     *
-     * @example <caption>Code example</caption>
-     * import { logsClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await logsClient.getLogRecords();
-     *
-     * @throws {ErrorEnvelopeError} Failed. The input is invalid. | Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    getLogRecords(config?: {
-        /**
-         * The start of the requested timeframe.
-         *
-         * You can use one of the following formats:
-         * * Timestamp in UTC milliseconds.
-         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
-         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
-         * You can also specify relative timeframe without an alignment: `now-NU`.
-         * Supported time units for the relative timeframe are:
-         *    * `m`: minutes
-         *    * `h`: hours
-         *    * `d`: days
-         *    * `w`: weeks
-         *    * `M`: months
-         *    * `y`: years
-         *
-         * If not set, the relative timeframe of two weeks is used (`now-2w`).
-         */ from?: string;
-        /**
-         * The end of the requested timeframe.
-         *
-         * You can use one of the following formats:
-         * * Timestamp in UTC milliseconds.
-         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
-         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
-         * You can also specify relative timeframe without an alignment: `now-NU`.
-         * Supported time units for the relative timeframe are:
-         *    * `m`: minutes
-         *    * `h`: hours
-         *    * `d`: days
-         *    * `w`: weeks
-         *    * `M`: months
-         *    * `y`: years
-         *
-         * If not set, the current timestamp is used.
-         */ to?: string;
-        /**
-         * The desired amount of log records.
-         *
-         * The maximal allowed limit is 1000.
-         *
-         * If not set, 1000 is used.
-         */ limit?: number;
-        /**
-         * The log search query.
-         *
-         * The query must use the [Dynatrace search query language](https://dt-url.net/pe03s6f).
-         */ query?: string;
-        /**
-         * Defines the ordering of the log records.
-         *
-         * Each field has a sign prefix (+/-) for sorting order. If no sign prefix is set, then the `+` option will be applied.
-         *
-         * Currently, ordering is available only for the timestamp (+timestamp for the oldest records first, or -timestamp for the newest records first).
-         *
-         * When millisecond resolution provided by the timestamp is not enough, log records are sorted based on the order in which they appear in the log source (remote process writing to REST API endpoint or remote process from which logs are collected).
-         */ sort?: string;
-        /**
-         * The cursor for the next slice of results. You can find it in the **nextSliceKey** field of the previous response.
-         *
-         * The first slice is always returned if you don't specify this parameter.
-         *
-         * If this parameter is set, all other query parameters are ignored.
-         *
-         * Unsupported on *Log Management and Analytics, powered by Grail*.
-         */ nextSliceKey?: string;
-        abortSignal?: AbortSignal;
-    }): Promise<LogRecordsList>;
-}
-export declare const logsClient: LogsClient;