Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions docs/modules/n1ql-rest-admin/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5004,6 +5004,51 @@ If specified, all completed queries with this user name are logged.
a| String


a|
*statement* +
_optional_
a|

[markdown]
--
A LIKE search pattern to match against the query text.
If specified, all completed queries where the pattern is found are logged.

--

[%hardbreaks]
*Default:* `pass:c[""]`
*Example:* `pass:c["%FIND USER%"]`
{blank}
a| String


a|
*plan* +
_optional_
a|

Comment thread
rakhi-prathap marked this conversation as resolved.
[markdown]
--
A JSON object containing one or more field:value pairs to match against the query plan.
Each pair describes a field in the query plan and the value it must have.

If specified, all completed queries where the field:value pairs are found in the plan are logged.
If multiple field:value pairs are specified, then all pairs must be matched (using AND).

Each field:value pair must be unique, but fields can be repeated.
Values can be strings, numbers, arrays, or any other JSON values.
For example, {"index":"ix1"},{"index":"ix2"} specifies that there should be an "index" field in the plan with the value "ix1" AND another "index" field with the value "ix2".

--

[%hardbreaks]
*Default:* `{}`
*Example:* `{"index":"ix1"}`
{blank}
a| Object


|===

//end::Logging_Parameters[]
Expand Down
26 changes: 26 additions & 0 deletions src/admin/swagger/admin.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1470,6 +1470,32 @@ components:
description: |
A user name, as given in the request credentials.
If specified, all completed queries with this user name are logged.
statement:
type: string
default: ""
example: "%FIND USER%"
x-has-default: true
x-has-example: true
description: |
A LIKE search pattern to match against the query text.
If specified, all completed queries where the pattern is found are logged.
plan:
type: object
default: {}
example: {"index":"ix1"}
x-has-default: true
x-has-example: true
description: |
A JSON object containing one or more field:value pairs to match against the query plan.
Each pair describes a field in the query plan and the value it must have.

If specified, all completed queries where the field:value pairs are found in the plan are logged.
If multiple field:value pairs are specified, then all pairs must be matched (using AND).

Each field:value pair must be unique, but fields can be repeated.
Values can be strings, numbers, arrays, or any other JSON values.
For example, {"index":"ix1"},{"index":"ix2"} specifies that there should be an "index" field in the plan with the value "ix1" AND another "index" field with the value "ix2".

completed-limit:
type: integer
format: int32
Expand Down