search-logs

Description

Submit a query to search logs.

Usage

oci logging-search search-logs [OPTIONS]

Required Parameters

--search-query [text]

Query corresponding to the search operation. This query is parsed and validated before execution and should follow the specification. For more information on the query language specification, see Logging Query Language Specification.

--time-end [datetime]

End filter log’s date and time, in the format defined by RFC3339.

The following datetime formats are supported:

Format: YYYY-MM-DDTHH:mm:ss.sssTZD
Example: 2017-09-15T20:30:00.123Z
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T20:30:00Z
Format: YYYY-MM-DDTHH:mmTZD
Example: 2017-09-15T20:30Z
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800
Format: YYYY-MM-DDTHH:mmTZD
Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800

The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)

Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
Example: '2017-09-15 17:25'

This date will be taken as midnight UTC of that day

Format: YYYY-MM-DD
Example: 2017-09-15
Example: 1412195400
--time-start [datetime]

Start filter log’s date and time, in the format defined by RFC3339.

The following datetime formats are supported:

Format: YYYY-MM-DDTHH:mm:ss.sssTZD
Example: 2017-09-15T20:30:00.123Z
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T20:30:00Z
Format: YYYY-MM-DDTHH:mmTZD
Example: 2017-09-15T20:30Z
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800
Format: YYYY-MM-DDTHH:mmTZD
Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800

The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)

Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
Example: '2017-09-15 17:25'

This date will be taken as midnight UTC of that day

Format: YYYY-MM-DD
Example: 2017-09-15
Example: 1412195400

Optional Parameters

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--is-return-field-info [boolean]

Whether to return field schema information for the log stream specified in searchQuery.

--limit [integer]

The maximum number of items to return in a response. Pagination is not supported in this API.

--page [text]

Reserved for future use. Pagination is not supported in this API.

Examples

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export search_query=<substitute-value-of-search_query> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/logging-search/search-logs.html#cmdoption-search-query
    export time_end=<substitute-value-of-time_end> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/logging-search/search-logs.html#cmdoption-time-end
    export time_start=<substitute-value-of-time_start> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/logging-search/search-logs.html#cmdoption-time-start

    oci logging-search search-logs --search-query $search_query --time-end $time_end --time-start $time_start