Adds feedback mechanism and more site visual improvements (#2259)
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
This commit is contained in:
kolchfa-aws
GitHub
parent
700649e6f5
commit
0402d132dd
|
|
@ -33,6 +33,7 @@ POST _aliases
|
|||
]
|
||||
}
|
||||
```
|
||||
{% include copy-curl.html %}
|
||||
|
||||
## Path and HTTP methods
|
||||
|
||||
|
|
|
|||
|
|
@ -627,116 +627,116 @@ The `indices` object contains the index statistics for each index with shards on
|
|||
Field | Field type | Description
|
||||
:--- | :--- | :---
|
||||
docs | Object | Document statistics for all primary shards that exist on the node.
|
||||
docs.<br> count | Integer | The number of documents reported by Lucene. Excludes deleted documents and recently indexed documents that are not yet assigned to a segment. Nested documents are counted separately.
|
||||
docs.<br> deleted | Integer | The number of deleted documents reported by Lucene. Excludes recent deletion operations that have not yet affect the segment.
|
||||
docs.count | Integer | The number of documents reported by Lucene. Excludes deleted documents and recently indexed documents that are not yet assigned to a segment. Nested documents are counted separately.
|
||||
docs.deleted | Integer | The number of deleted documents reported by Lucene. Excludes recent deletion operations that have not yet affect the segment.
|
||||
store | Object | Statistics about the shard sizes of the shards on the node.
|
||||
store.<br> size_in_bytes | Integer | Total size of all shards on the node.
|
||||
store.<br> reserved_in_bytes | Integer | The predicted number of bytes the shard store will grow to be because of activities such as restoring snapshots and peer recoveries.
|
||||
store.size_in_bytes | Integer | Total size of all shards on the node.
|
||||
store.reserved_in_bytes | Integer | The predicted number of bytes the shard store will grow to be because of activities such as restoring snapshots and peer recoveries.
|
||||
indexing | Object | Statistics about indexing operations for the node.
|
||||
indexing.<br> index_total | Integer | The total number of indexing operations on the node.
|
||||
indexing.<br> index_time_in_millis | Integer | The total time for all indexing operations, in milliseconds.
|
||||
indexing.<br> index_current | Integer | The number of indexing operations that are currently running.
|
||||
indexing.<br> index_failed | Integer | The number of indexing operations that have failed.
|
||||
indexing.<br> delete_total | Integer | The total number of deletions.
|
||||
indexing.<br> delete_time_in_millis | Integer | The total time for all deletion operations, in milliseconds.
|
||||
indexing.<br> delete_current | Integer | The number of deletion operations that are currently running.
|
||||
indexing.<br> noop_update_total | Integer | The total number of noop operations.
|
||||
indexing.<br> is_throttled | Boolean | Specifies whether any operations were throttled.
|
||||
indexing.<br> throttle_time_in_millis | Integer | The total time for throttling operations, in milliseconds.
|
||||
indexing.index_total | Integer | The total number of indexing operations on the node.
|
||||
indexing.index_time_in_millis | Integer | The total time for all indexing operations, in milliseconds.
|
||||
indexing.index_current | Integer | The number of indexing operations that are currently running.
|
||||
indexing.index_failed | Integer | The number of indexing operations that have failed.
|
||||
indexing.delete_total | Integer | The total number of deletions.
|
||||
indexing.delete_time_in_millis | Integer | The total time for all deletion operations, in milliseconds.
|
||||
indexing.delete_current | Integer | The number of deletion operations that are currently running.
|
||||
indexing.noop_update_total | Integer | The total number of noop operations.
|
||||
indexing.is_throttled | Boolean | Specifies whether any operations were throttled.
|
||||
indexing.throttle_time_in_millis | Integer | The total time for throttling operations, in milliseconds.
|
||||
get | Object | Statistics about the get operations for the node.
|
||||
get.<br> total | Integer | The total number of get operations.
|
||||
get.<br> time_in_millis | Integer | The total time for all get operations, in milliseconds.
|
||||
get.<br> exists_total | Integer | The total number of successful get operations.
|
||||
get.<br> exists_time_in_millis | Integer | The total time for all successful get operations, in milliseconds.
|
||||
get.<br> missing_total | Integer | The number of failed get operations.
|
||||
get.<br> missing_time_in_millis | Integer | The total time for all failed get operations, in milliseconds.
|
||||
get.<br> current | Integer | The number of get operations that are currently running.
|
||||
get.total | Integer | The total number of get operations.
|
||||
get.time_in_millis | Integer | The total time for all get operations, in milliseconds.
|
||||
get.exists_total | Integer | The total number of successful get operations.
|
||||
get.exists_time_in_millis | Integer | The total time for all successful get operations, in milliseconds.
|
||||
get.missing_total | Integer | The number of failed get operations.
|
||||
get.missing_time_in_millis | Integer | The total time for all failed get operations, in milliseconds.
|
||||
get.current | Integer | The number of get operations that are currently running.
|
||||
search | Object | Statistics about the search operations for the node.
|
||||
search.<br> point_in_time_total | Integer | The total number of Point in Time contexts that have been created (completed and active) since the node last restarted.
|
||||
search.<br> point_in_time_time_in_millis | Integer | The amount of time that Point in Time contexts have been held open since the node last restarted, in milliseconds.
|
||||
search.<br> point_in_time_current | Integer | The number of Point in Time contexts currently open.
|
||||
search.<br> open_contexts | Integer | The number of open search contexts.
|
||||
search.<br> query_total | Integer | The total number of query operations.
|
||||
search.<br> query_time_in_millis | Integer | The total time for all query operations, in milliseconds.
|
||||
search.<br> query_current | Integer | The number of query operations that are currently running.
|
||||
search.<br> fetch_total | Integer | The total number of fetch operations.
|
||||
search.<br> fetch_time_in_millis | Integer | The total time for all fetch operations, in milliseconds.
|
||||
search.<br> fetch_current | Integer | The number of fetch operations that are currently running.
|
||||
search.<br> scroll_total | Integer | The total number of scroll operations.
|
||||
search.<br> scroll_time_in_millis | Integer | The total time for all scroll operations, in milliseconds.
|
||||
search.<br> scroll_current | Integer | The number of scroll operations that are currently running.
|
||||
search.<br> suggest_total | Integer | The total number of suggest operations.
|
||||
search.<br> suggest_time_in_millis | Integer | The total time for all suggest operations, in milliseconds.
|
||||
search.<br> suggest_current | Integer | The number of suggest operations that are currently running.
|
||||
search.point_in_time_total | Integer | The total number of Point in Time contexts that have been created (completed and active) since the node last restarted.
|
||||
search.point_in_time_time_in_millis | Integer | The amount of time that Point in Time contexts have been held open since the node last restarted, in milliseconds.
|
||||
search.point_in_time_current | Integer | The number of Point in Time contexts currently open.
|
||||
search.open_contexts | Integer | The number of open search contexts.
|
||||
search.query_total | Integer | The total number of query operations.
|
||||
search.query_time_in_millis | Integer | The total time for all query operations, in milliseconds.
|
||||
search.query_current | Integer | The number of query operations that are currently running.
|
||||
search.fetch_total | Integer | The total number of fetch operations.
|
||||
search.fetch_time_in_millis | Integer | The total time for all fetch operations, in milliseconds.
|
||||
search.fetch_current | Integer | The number of fetch operations that are currently running.
|
||||
search.scroll_total | Integer | The total number of scroll operations.
|
||||
search.scroll_time_in_millis | Integer | The total time for all scroll operations, in milliseconds.
|
||||
search.scroll_current | Integer | The number of scroll operations that are currently running.
|
||||
search.suggest_total | Integer | The total number of suggest operations.
|
||||
search.suggest_time_in_millis | Integer | The total time for all suggest operations, in milliseconds.
|
||||
search.suggest_current | Integer | The number of suggest operations that are currently running.
|
||||
merges | Object | Statistics about merge operations for the node.
|
||||
merges.<br> current | Integer | The number of merge operations that are currently running.
|
||||
merges.<br> current_docs | Integer | The number of document merges that are currently running.
|
||||
merges.<br> current_size_in_bytes | Integer | The memory size, in bytes, that is used to perform current merge operations.
|
||||
merges.<br> total | Integer | The total number of merge operations.
|
||||
merges.<br> total_time_in_millis | Integer | The total time for merges, in milliseconds.
|
||||
merges.<br> total_docs | Integer | The total number of documents that have been merged.
|
||||
merges.<br> total_size_in_bytes | Integer | The total size of all merged documents, in bytes.
|
||||
merges.<br> total_stopped_time_in_millis | Integer | The total time spent on stopping merge operations, in milliseconds.
|
||||
merges.<br> total_throttled_time_in_millis | Integer | The total time spent on throttling merge operations, in milliseconds.
|
||||
merges.<br> total_auto_throttle_in_bytes | Integer | The total size of automatically throttled merge operations, in bytes.
|
||||
merges.current | Integer | The number of merge operations that are currently running.
|
||||
merges.current_docs | Integer | The number of document merges that are currently running.
|
||||
merges.current_size_in_bytes | Integer | The memory size, in bytes, that is used to perform current merge operations.
|
||||
merges.total | Integer | The total number of merge operations.
|
||||
merges.total_time_in_millis | Integer | The total time for merges, in milliseconds.
|
||||
merges.total_docs | Integer | The total number of documents that have been merged.
|
||||
merges.total_size_in_bytes | Integer | The total size of all merged documents, in bytes.
|
||||
merges.total_stopped_time_in_millis | Integer | The total time spent on stopping merge operations, in milliseconds.
|
||||
merges.total_throttled_time_in_millis | Integer | The total time spent on throttling merge operations, in milliseconds.
|
||||
merges.total_auto_throttle_in_bytes | Integer | The total size of automatically throttled merge operations, in bytes.
|
||||
refresh | Object | Statistics about refresh operations for the node.
|
||||
refresh.<br> total | Integer | The total number of refresh operations.
|
||||
refresh.<br> total_time_in_millis | Integer | The total time for all refresh operations, in milliseconds.
|
||||
refresh.<br> external_total | Integer | The total number of external refresh operations.
|
||||
refresh.<br> external_total_time_in_millis | Integer | The total time for all external refresh operations, in milliseconds.
|
||||
refresh.<br> listeners | Integer | The number of refresh listeners.
|
||||
refresh.total | Integer | The total number of refresh operations.
|
||||
refresh.total_time_in_millis | Integer | The total time for all refresh operations, in milliseconds.
|
||||
refresh.external_total | Integer | The total number of external refresh operations.
|
||||
refresh.external_total_time_in_millis | Integer | The total time for all external refresh operations, in milliseconds.
|
||||
refresh.listeners | Integer | The number of refresh listeners.
|
||||
flush | Object | Statistics about flush operations for the node.
|
||||
flush.<br> total | Integer | The total number of flush operations.
|
||||
flush.<br> periodic | Integer | The total number of periodic flush operations.
|
||||
flush.<br> total_time_in_millis | Integer | The total time for all flush operations, in milliseconds.
|
||||
flush.total | Integer | The total number of flush operations.
|
||||
flush.periodic | Integer | The total number of periodic flush operations.
|
||||
flush.total_time_in_millis | Integer | The total time for all flush operations, in milliseconds.
|
||||
warmer | Object | Statistics about the index warming operations for the node.
|
||||
warmer.<br> current | Integer | The number of current index warming operations.
|
||||
warmer.<br> total | Integer | The total number of index warming operations.
|
||||
warmer.<br> total_time_in_millis | Integer | The total time for all index warming operations, in milliseconds.
|
||||
warmer.current | Integer | The number of current index warming operations.
|
||||
warmer.total | Integer | The total number of index warming operations.
|
||||
warmer.total_time_in_millis | Integer | The total time for all index warming operations, in milliseconds.
|
||||
query_cache | Statistics about query cache operations for the node.
|
||||
query_cache.<br> memory_size_in_bytes | Integer | The amount of memory used for the query cache for all shards in the node.
|
||||
query_cache.<br> total_count | Integer | The total number of hits, misses, and cached queries in the query cache.
|
||||
query_cache.<br> hit_count | Integer | The total number of hits in the query cache.
|
||||
query_cache.<br> miss_count | Integer | The total number of misses in the query cache.
|
||||
query_cache.<br> cache_size | Integer | The size of the query cache, in bytes.
|
||||
query_cache.<br> cache_count | Integer | The number of queries in the query cache.
|
||||
query_cache.<br> evictions | Integer | The number of evictions in the query cache.
|
||||
query_cache.memory_size_in_bytes | Integer | The amount of memory used for the query cache for all shards in the node.
|
||||
query_cache.total_count | Integer | The total number of hits, misses, and cached queries in the query cache.
|
||||
query_cache.hit_count | Integer | The total number of hits in the query cache.
|
||||
query_cache.miss_count | Integer | The total number of misses in the query cache.
|
||||
query_cache.cache_size | Integer | The size of the query cache, in bytes.
|
||||
query_cache.cache_count | Integer | The number of queries in the query cache.
|
||||
query_cache.evictions | Integer | The number of evictions in the query cache.
|
||||
fielddata | Object | Statistics about the field data cache for all shards in the node.
|
||||
fielddata.<br> memory_size_in_bytes | Integer | The total amount of memory used for the field data cache for all shards in the node.
|
||||
fielddata.<br> evictions | Integer | The number of evictions in the field data cache.
|
||||
fielddata.<br> fields | Object | Contains all field data fields.
|
||||
fielddata.memory_size_in_bytes | Integer | The total amount of memory used for the field data cache for all shards in the node.
|
||||
fielddata.evictions | Integer | The number of evictions in the field data cache.
|
||||
fielddata.fields | Object | Contains all field data fields.
|
||||
completion | Object | Statistics about completions for all shards in the node.
|
||||
completion.<br> size_in_bytes | Integer | The total amount of memory used for completion for all shards in the node, in bytes.
|
||||
completion.<br> fields | Object | Contains completion fields.
|
||||
completion.size_in_bytes | Integer | The total amount of memory used for completion for all shards in the node, in bytes.
|
||||
completion.fields | Object | Contains completion fields.
|
||||
segments | Object | Statistics about segments for all shards in the node.
|
||||
segments.<br> count | Integer | The total number of segments.
|
||||
segments.<br> memory_in_bytes | Integer | The total amount of memory, in bytes.
|
||||
segments.<br> terms_memory_in_bytes | Integer | The total amount of memory used for terms, in bytes.
|
||||
segments.<br> stored_fields_memory_in_bytes | Integer | The total amount of memory used for stored fields, in bytes.
|
||||
segments.<br> term_vectors_memory_in_bytes | Integer | The total amount of memory used for term vectors, in bytes.
|
||||
segments.<br> norms_memory_in_bytes | Integer | The total amount of memory used for normalization factors, in bytes.
|
||||
segments.<br> points_memory_in_bytes | Integer | The total amount of memory used for points, in bytes.
|
||||
segments.<br> doc_values_memory_in_bytes | Integer | The total amount of memory used for doc values, in bytes.
|
||||
segments.<br> index_writer_memory_in_bytes | Integer | The total amount of memory used by all index writers, in bytes.
|
||||
segments.<br> version_map_memory_in_bytes | Integer | The total amount of memory used by all version maps, in bytes.
|
||||
segments.<br> fixed_bit_set_memory_in_bytes | Integer | The total amount of memory used by fixed bit sets, in bytes. Fixed bit sets are used for nested objects and join fields.
|
||||
segments.<br> max_unsafe_auto_id_timestamp | Integer | The timestamp for the most recently retired indexing request, in milliseconds since the epoch.
|
||||
segments.<br> file_sizes | Integer | Statistics about the size of the segment files.
|
||||
segments.count | Integer | The total number of segments.
|
||||
segments.memory_in_bytes | Integer | The total amount of memory, in bytes.
|
||||
segments.terms_memory_in_bytes | Integer | The total amount of memory used for terms, in bytes.
|
||||
segments.stored_fields_memory_in_bytes | Integer | The total amount of memory used for stored fields, in bytes.
|
||||
segments.term_vectors_memory_in_bytes | Integer | The total amount of memory used for term vectors, in bytes.
|
||||
segments.norms_memory_in_bytes | Integer | The total amount of memory used for normalization factors, in bytes.
|
||||
segments.points_memory_in_bytes | Integer | The total amount of memory used for points, in bytes.
|
||||
segments.doc_values_memory_in_bytes | Integer | The total amount of memory used for doc values, in bytes.
|
||||
segments.index_writer_memory_in_bytes | Integer | The total amount of memory used by all index writers, in bytes.
|
||||
segments.version_map_memory_in_bytes | Integer | The total amount of memory used by all version maps, in bytes.
|
||||
segments.fixed_bit_set_memory_in_bytes | Integer | The total amount of memory used by fixed bit sets, in bytes. Fixed bit sets are used for nested objects and join fields.
|
||||
segments.max_unsafe_auto_id_timestamp | Integer | The timestamp for the most recently retired indexing request, in milliseconds since the epoch.
|
||||
segments.file_sizes | Integer | Statistics about the size of the segment files.
|
||||
translog | Object | Statistics about transaction log operations for the node.
|
||||
translog.<br> operations | Integer | The number of translog operations.
|
||||
translog.<br> size_in_bytes | Integer | The size of the translog, in bytes.
|
||||
translog.<br> uncommitted_operations | Integer | The number of uncommitted translog operations.
|
||||
translog.<br> uncommitted_size_in_bytes | Integer | The size of uncommitted translog operations, in bytes.
|
||||
translog.<br> earliest_last_modified_age | Integer | The earliest last modified age for the translog.
|
||||
translog.operations | Integer | The number of translog operations.
|
||||
translog.size_in_bytes | Integer | The size of the translog, in bytes.
|
||||
translog.uncommitted_operations | Integer | The number of uncommitted translog operations.
|
||||
translog.uncommitted_size_in_bytes | Integer | The size of uncommitted translog operations, in bytes.
|
||||
translog.earliest_last_modified_age | Integer | The earliest last modified age for the translog.
|
||||
request_cache | Object | Statistics about the request cache for the node.
|
||||
request_cache.<br> memory_size_in_bytes | Integer | The memory size used by the request cache, in bytes.
|
||||
request_cache.<br> evictions | Integer | The number of request cache evictions.
|
||||
request_cache.<br> hit_count | Integer | The number of request cache hits.
|
||||
request_cache.<br> miss_count | Integer | The number of request cache misses.
|
||||
request_cache.memory_size_in_bytes | Integer | The memory size used by the request cache, in bytes.
|
||||
request_cache.evictions | Integer | The number of request cache evictions.
|
||||
request_cache.hit_count | Integer | The number of request cache hits.
|
||||
request_cache.miss_count | Integer | The number of request cache misses.
|
||||
recovery | Object | Statistics about recovery operations for the node.
|
||||
recovery.<br> current_as_source | Integer | The number of recovery operations that have used an index shard as a source.
|
||||
recovery.<br> current_as_target | Integer | The number of recovery operations that have used an index shard as a target.
|
||||
recovery.<br> throttle_time_in_millis | Integer | The delay of recovery operations due to throttling, in milliseconds.
|
||||
recovery.current_as_source | Integer | The number of recovery operations that have used an index shard as a source.
|
||||
recovery.current_as_target | Integer | The number of recovery operations that have used an index shard as a target.
|
||||
recovery.throttle_time_in_millis | Integer | The delay of recovery operations due to throttling, in milliseconds.
|
||||
|
||||
|
||||
### `os`
|
||||
|
|
@ -753,19 +753,19 @@ cpu.load_average.1m | Float | The load average for the system for the time perio
|
|||
cpu.load_average.5m | Float | The load average for the system for the time period of five minutes.
|
||||
cpu.load_average.15m | Float | The load average for the system for the time period of 15 minutes.
|
||||
cpu.mem | Object | Statistics about memory usage for the node.
|
||||
cpu.mem. total_in_bytes | Integer | The total amount of physical memory, in bytes.
|
||||
cpu.mem. free_in_bytes | Integer | The total amount of free physical memory, in bytes.
|
||||
cpu.mem. used_in_bytes | Integer | The total amount of used physical memory, in bytes.
|
||||
cpu.mem. free_percent | Integer | The percentage of memory that is free.
|
||||
cpu.mem. used_percent | Integer | The percentage of memory that is used.
|
||||
cpu.mem.total_in_bytes | Integer | The total amount of physical memory, in bytes.
|
||||
cpu.mem.free_in_bytes | Integer | The total amount of free physical memory, in bytes.
|
||||
cpu.mem.used_in_bytes | Integer | The total amount of used physical memory, in bytes.
|
||||
cpu.mem.free_percent | Integer | The percentage of memory that is free.
|
||||
cpu.mem.used_percent | Integer | The percentage of memory that is used.
|
||||
cpu.swap | Object | Statistics about swap space for the node.
|
||||
cpu.swap. total_in_bytes | Integer | The total amount of swap space, in bytes.
|
||||
cpu.swap.total_in_bytes | Integer | The total amount of swap space, in bytes.
|
||||
cpu.swap.free_in_bytes | Integer | The total amount of free swap space, in bytes.
|
||||
cpu.swap. used_in_bytes | Integer | The total amount of used swap space, in bytes.
|
||||
cpu.swap.used_in_bytes | Integer | The total amount of used swap space, in bytes.
|
||||
cpu.cgroup | Object | Contains cgroup statistics for the node. Returned for Linux only.
|
||||
cpu.cgroup.cpuacct | Object | Statistics about the cpuacct control group for the node.
|
||||
cpu.cgroup. cpu | Object | Statistics about the CPU control group for the node.
|
||||
cpu.cgroup. memory | Object | Statistics about the memory control group for the node.
|
||||
cpu.cgroup.cpu | Object | Statistics about the CPU control group for the node.
|
||||
cpu.cgroup.memory | Object | Statistics about the memory control group for the node.
|
||||
|
||||
### `process`
|
||||
|
||||
|
|
@ -952,12 +952,12 @@ The `indexing_pressure` object contains the indexing pressure statistics and has
|
|||
Field | Field type | Description
|
||||
:--- | :--- | :---
|
||||
memory | Object | Statistics related to memory consumption for the indexing load.
|
||||
memory.<br> current | Object | Statistics related to memory consumption for the current indexing load.
|
||||
memory.<br> current.<br> combined_coordinating_and_primary_in_bytes | Integer | The total memory used by indexing requests in the coordinating or primary stages, in bytes. A node can reuse the coordinating memory if the primary stage is run locally, so the total memory does not necessarily equal the sum of the coordinating and primary stage memory usage.
|
||||
memory.<br> current.<br> coordinating_in_bytes | The total memory consumed by indexing requests in the coordinating stage, in bytes.
|
||||
memory.<br> current.<br> primary_in_bytes | Integer | The total memory consumed by indexing requests in the primary stage, in bytes.
|
||||
memory.<br> current.<br> replica_in_bytes | Integer | The total memory consumed by indexing requests in the replica stage, in bytes.
|
||||
memory.<br> current.<br> all_in_bytes | Integer | The total memory consumed by indexing requests in the coordinating, primary, or replica stages.
|
||||
memory.current | Object | Statistics related to memory consumption for the current indexing load.
|
||||
memory.current.combined_coordinating_and_primary_in_bytes | Integer | The total memory used by indexing requests in the coordinating or primary stages, in bytes. A node can reuse the coordinating memory if the primary stage is run locally, so the total memory does not necessarily equal the sum of the coordinating and primary stage memory usage.
|
||||
memory.current.coordinating_in_bytes | The total memory consumed by indexing requests in the coordinating stage, in bytes.
|
||||
memory.current.primary_in_bytes | Integer | The total memory consumed by indexing requests in the primary stage, in bytes.
|
||||
memory.current.replica_in_bytes | Integer | The total memory consumed by indexing requests in the replica stage, in bytes.
|
||||
memory.current.all_in_bytes | Integer | The total memory consumed by indexing requests in the coordinating, primary, or replica stages.
|
||||
|
||||
### `shard_indexing_pressure`
|
||||
|
||||
|
|
@ -967,9 +967,9 @@ Field | Field type | Description
|
|||
:--- | :--- | :---
|
||||
[stats]({{site.url}}{{site.baseurl}}/opensearch/stats-api/) | Object | Statistics about shard indexing pressure.
|
||||
total_rejections_breakup_shadow_mode | Object | If running in shadow mode, the `total_rejections_breakup_shadow_mode` object contains statistics about the request rejection criteria of all shards in the node.
|
||||
total_rejections_breakup_shadow_mode.<br> node_limits | Integer | The total number of rejections due to the node memory limit. When all shards reach the memory limit assigned to the node (for example, 10% of heap size), the shard is unable to take in more traffic on the node, and the indexing request is rejected.
|
||||
total_rejections_breakup_shadow_mode.<br> no_successful_request_limits | Integer | The total number of rejections when the node occupancy level is breaching its soft limit and the shard has multiple outstanding requests that are waiting to be executed. In this case, additional indexing requests are rejected until the system recovers.
|
||||
total_rejections_breakup_shadow_mode.<br> throughput_degradation_limits | Integer | The total number of rejections when the node occupancy level is breaching its soft limit and there is a constant deterioration in the request turnaround at the shard level. In this case, additional indexing requests are rejected until the system recovers.
|
||||
total_rejections_breakup_shadow_mode.node_limits | Integer | The total number of rejections due to the node memory limit. When all shards reach the memory limit assigned to the node (for example, 10% of heap size), the shard is unable to take in more traffic on the node, and the indexing request is rejected.
|
||||
total_rejections_breakup_shadow_mode.no_successful_request_limits | Integer | The total number of rejections when the node occupancy level is breaching its soft limit and the shard has multiple outstanding requests that are waiting to be executed. In this case, additional indexing requests are rejected until the system recovers.
|
||||
total_rejections_breakup_shadow_mode.throughput_degradation_limits | Integer | The total number of rejections when the node occupancy level is breaching its soft limit and there is a constant deterioration in the request turnaround at the shard level. In this case, additional indexing requests are rejected until the system recovers.
|
||||
enabled | Boolean | Specifies whether the shard indexing pressure feature is turned on for the node.
|
||||
enforced | Boolean | If true, the shard indexing pressure runs in enforced mode (there are rejections). If false, the shard indexing pressure runs in shadow mode (there are no rejections, but statistics are recorded and can be retrieved in the `total_rejections_breakup_shadow_mode` object). Only applicable if shard indexing pressure is enabled.
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<div>
|
||||
<button id="yes" type="button" value="yes" class="feedback-button">✔ Yes</button>
|
||||
<button id="no" type="button" value="no" class="feedback-button">✖ No</button>
|
||||
<p id="feedback-response"></p>
|
||||
<p class="text-small text-grey-dk-100 hidden">Thank you for your feedback!</p>
|
||||
</div>
|
||||
<p class="text-small text-grey-dk-100">See a problem? Submit <a href="https://github.com/opensearch-project/documentation-website/issues">issues</a> or <a href="https://github.com/opensearch-project/documentation-website/edit/main/{{ page.path }}">edit this page</a> on <a href="https://github.com/opensearch-project/documentation-website/">GitHub</a>.</p>
|
||||
<p class="text-small text-grey-dk-100">See a problem? Submit <a class="feedback-issue" href="https://github.com/opensearch-project/documentation-website/issues">issues</a> or <a class="feedback-edit" href="https://github.com/opensearch-project/documentation-website/edit/main/{{ page.path }}">edit this page</a> on <a href="https://github.com/opensearch-project/documentation-website/">GitHub</a>.</p>
|
||||
</div>
|
||||
|
|
@ -96,9 +96,6 @@ layout: table_wrappers
|
|||
{% endif %}
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
<div class="site-footer">
|
||||
<p class="text-small text-grey-dk-100">See a problem? Submit <a href="https://github.com/opensearch-project/documentation-website/issues">issues</a> or <a href="https://github.com/opensearch-project/documentation-website/edit/main/{{ page.path }}">edit this page</a> on <a href="https://github.com/opensearch-project/documentation-website/">GitHub</a>.</p>
|
||||
</div>
|
||||
</nav>
|
||||
</div>
|
||||
<div class="copy-banner">
|
||||
|
|
@ -152,7 +149,7 @@ layout: table_wrappers
|
|||
{% endif %}
|
||||
|
||||
<a class="top-link" href="#top">
|
||||
↑
|
||||
<svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
|
||||
{% if page.has_children == true and page.has_toc != false %}
|
||||
|
|
@ -166,10 +163,7 @@ layout: table_wrappers
|
|||
{% endfor %}
|
||||
</ul>
|
||||
{% endif %}
|
||||
<!--
|
||||
<hr>
|
||||
{% include feedback.html %}
|
||||
-->
|
||||
|
||||
{% capture footer_custom %}
|
||||
{%- include footer_custom.html -%}
|
||||
{% endcapture %}
|
||||
|
|
@ -208,9 +202,13 @@ layout: table_wrappers
|
|||
</div>
|
||||
</div>
|
||||
<div class="toc-wrap">
|
||||
<div class="toc">
|
||||
{% include toc.html html=content h_min=2 h_max=2 class="toc-list" item_class="toc-item" sanitize=true %}
|
||||
<div class="sticky-wrap">
|
||||
<div class="toc">
|
||||
{% include toc.html html=content h_min=2 h_max=2 class="toc-list" item_class="toc-item" sanitize=true %}
|
||||
</div>
|
||||
{% include feedback.html %}
|
||||
</div>
|
||||
{% comment %}{% include feedback.html %}{% endcomment %}
|
||||
</div>
|
||||
{% if site.search_enabled != false %}
|
||||
{% if site.search.button %}
|
||||
|
|
@ -236,5 +234,6 @@ layout: table_wrappers
|
|||
<script src="{{ '/assets/js/copy.js' | relative_url }}"></script>
|
||||
<script src="{{ '/assets/js/nav-scroll.js' | relative_url }}"></script>
|
||||
<script src="{{ '/assets/js/feedback.js' | relative_url }}"></script>
|
||||
<script src="{{ '/assets/js/link-feedback.js' | relative_url }}"></script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
|
|
@ -177,32 +177,32 @@ Parameter | Type | Description
|
|||
`description` | String | The description of the SM policy. Optional.
|
||||
`enabled` | Boolean | Should this SM policy be enabled at creation? Optional.
|
||||
`snapshot_config` | Object | The configuration options for snapshot creation. Required.
|
||||
`snapshot_config`<br> `date_format` | String | Snapshot names have the format `<policy_name>-<date>-<random number>`. `date_format` specifies the format for the date in the snapshot name. Supports all date formats supported by OpenSearch. Optional. Default is "yyyy-MM-dd'T'HH:mm:ss".
|
||||
`snapshot_config`<br> `date_format_timezone` | String | Snapshot names have the format `<policy_name>-<date>-<random number>`. `date_format_timezone` specifies the time zone for the date in the snapshot name. Optional. Default is UTC.
|
||||
`snapshot_config`<br> `indices` | String | The names of the indexes in the snapshot. Multiple index names are separated by `,`. Supports wildcards (`*`). Optional. Default is `*` (all indexes).
|
||||
`snapshot_config`<br> `repository` | String | The repository in which to store snapshots. Required.
|
||||
`snapshot_config`<br> `ignore_unavailable` | Boolean | Do you want to ignore unavailable indexes? Optional. Default is `false`.
|
||||
`snapshot_config`<br> `include_global_state` | Boolean | Do you want to include cluster state? Optional. Default is `true` because of [Security plugin considerations]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore/#security-plugin-considerations).
|
||||
`snapshot_config`<br> `partial` | Boolean | Do you want to allow partial snapshots? Optional. Default is `false`.
|
||||
`snapshot_config`<br> `metadata` | Object | Metadata in the form of key/value pairs. Optional.
|
||||
`snapshot_config.date_format` | String | Snapshot names have the format `<policy_name>-<date>-<random number>`. `date_format` specifies the format for the date in the snapshot name. Supports all date formats supported by OpenSearch. Optional. Default is "yyyy-MM-dd'T'HH:mm:ss".
|
||||
`snapshot_config.date_format_timezone` | String | Snapshot names have the format `<policy_name>-<date>-<random number>`. `date_format_timezone` specifies the time zone for the date in the snapshot name. Optional. Default is UTC.
|
||||
`snapshot_config.indices` | String | The names of the indexes in the snapshot. Multiple index names are separated by `,`. Supports wildcards (`*`). Optional. Default is `*` (all indexes).
|
||||
`snapshot_config.repository` | String | The repository in which to store snapshots. Required.
|
||||
`snapshot_config.ignore_unavailable` | Boolean | Do you want to ignore unavailable indexes? Optional. Default is `false`.
|
||||
`snapshot_config.include_global_state` | Boolean | Do you want to include cluster state? Optional. Default is `true` because of [Security plugin considerations]({{site.url}}{{site.baseurl}}/opensearch/snapshots/snapshot-restore/#security-plugin-considerations).
|
||||
`snapshot_config.partial` | Boolean | Do you want to allow partial snapshots? Optional. Default is `false`.
|
||||
`snapshot_config.metadata` | Object | Metadata in the form of key/value pairs. Optional.
|
||||
`creation` | Object | Configuration for snapshot creation. Required.
|
||||
`creation`<br> `schedule` | String | The cron schedule used to create snapshots. Required.
|
||||
`creation`<br> `time_limit` | String | Sets the maximum time to wait for snapshot creation to finish. If time_limit is longer than the scheduled time interval for taking snapshots, no scheduled snapshots are taken until time_limit elapses. For example, if time_limit is set to 35 minutes and snapshots are taken every 30 minutes starting at midnight, the snapshots at 00:00 and 01:00 are taken, but the snapshot at 00:30 is skipped. Optional.
|
||||
`creation.schedule` | String | The cron schedule used to create snapshots. Required.
|
||||
`creation.time_limit` | String | Sets the maximum time to wait for snapshot creation to finish. If time_limit is longer than the scheduled time interval for taking snapshots, no scheduled snapshots are taken until time_limit elapses. For example, if time_limit is set to 35 minutes and snapshots are taken every 30 minutes starting at midnight, the snapshots at 00:00 and 01:00 are taken, but the snapshot at 00:30 is skipped. Optional.
|
||||
`deletion` | Object | Configuration for snapshot deletion. Optional. Default is to retain all snapshots.
|
||||
`deletion`<br> `schedule` | String | The cron schedule used to delete snapshots. Optional. Default is to use `creation.schedule`, which is required.
|
||||
`deletion`<br> `time_limit` | String | Sets the maximum time to wait for snapshot deletion to finish. Optional.
|
||||
`deletion`<br> `delete_condition` | Object | Conditions for snapshot deletion. Optional.
|
||||
`deletion`<br> `delete_condition`<br> `max_count` | Integer | The maximum number of snapshots to be retained. Optional.
|
||||
`deletion`<br> `delete_condition`<br> `max_age` | String | The maximum time a snapshot is retained. Optional.
|
||||
`deletion`<br> `delete_condition`<br> `min_count` | Integer | The minimum number of snapshots to be retained. Optional. Default is one.
|
||||
`deletion.schedule` | String | The cron schedule used to delete snapshots. Optional. Default is to use `creation.schedule`, which is required.
|
||||
`deletion.time_limit` | String | Sets the maximum time to wait for snapshot deletion to finish. Optional.
|
||||
`deletion.delete_condition` | Object | Conditions for snapshot deletion. Optional.
|
||||
`deletion.delete_condition.max_count` | Integer | The maximum number of snapshots to be retained. Optional.
|
||||
`deletion.delete_condition.max_age` | String | The maximum time a snapshot is retained. Optional.
|
||||
`deletion.delete_condition.min_count` | Integer | The minimum number of snapshots to be retained. Optional. Default is one.
|
||||
`notification` | Object | Defines notifications for SM events. Optional.
|
||||
`notification`<br> `channel` | Object | Defines a channel for notifications. You must [create and configure a notification channel]({{site.url}}{{site.baseurl}}/notifications-plugin/api) before setting up SM notifications. Required.
|
||||
`notification`<br> `channel`<br> `id` | String | The channel ID of the channel used for notifications. To get the channel IDs of all created channels, use `GET _plugins/_notifications/configs`. Required.
|
||||
`notification`<br> `conditions` | Object | SM events you want to be notified about. Set the ones you are interested in to `true`.
|
||||
`notification`<br> `conditions`<br> `creation` | Boolean | Do you want notifications about snapshot creation? Optional. Default is `true`.
|
||||
`notification`<br> `conditions`<br> `deletion` | Boolean | Do you want notifications about snapshot deletion? Optional. Default is `false`.
|
||||
`notification`<br> `conditions`<br> `failure` | Boolean | Do you want notifications about creation or deletion failure? Optional. Default is `false`.
|
||||
`notification`<br> `conditions`<br> `time_limit_exceeded` | Boolean | Do you want notifications when snapshot operations take longer than time_limit? Optional. Default is `false`.
|
||||
`notification.channel` | Object | Defines a channel for notifications. You must [create and configure a notification channel]({{site.url}}{{site.baseurl}}/notifications-plugin/api) before setting up SM notifications. Required.
|
||||
`notification.channel.id` | String | The channel ID of the channel used for notifications. To get the channel IDs of all created channels, use `GET _plugins/_notifications/configs`. Required.
|
||||
`notification.conditions` | Object | SM events you want to be notified about. Set the ones you are interested in to `true`.
|
||||
`notification.conditions.creation` | Boolean | Do you want notifications about snapshot creation? Optional. Default is `true`.
|
||||
`notification.conditions.deletion` | Boolean | Do you want notifications about snapshot deletion? Optional. Default is `false`.
|
||||
`notification.conditions.failure` | Boolean | Do you want notifications about creation or deletion failure? Optional. Default is `false`.
|
||||
`notification.conditions.time_limit_exceeded` | Boolean | Do you want notifications when snapshot operations take longer than time_limit? Optional. Default is `false`.
|
||||
|
||||
## Get policies
|
||||
Introduced 2.1
|
||||
|
|
|
|||
|
|
@ -1,5 +1,3 @@
|
|||
$content-width: 740px;
|
||||
|
||||
//
|
||||
// Brand colors
|
||||
//
|
||||
|
|
@ -64,6 +62,7 @@ $nav-child-link-color: $blue-200;
|
|||
$link-color: $blue-300;
|
||||
$btn-primary-color: $purple-300;
|
||||
$base-button-color: $grey-lt-300;
|
||||
$table-border-color: $grey-lt-300;
|
||||
|
||||
// $border-color: $grey-dk-200;
|
||||
// $search-result-preview-color: $grey-dk-000;
|
||||
|
|
@ -72,7 +71,9 @@ $base-button-color: $grey-lt-300;
|
|||
// $feedback-color: darken($sidebar-color, 3%);
|
||||
|
||||
$content-width: 740px;
|
||||
$toc-width: 232px;
|
||||
$max-content-width: 1080px;
|
||||
$top-button-margin: 48px;
|
||||
$toc-width: 264px;
|
||||
|
||||
$media-queries: (
|
||||
xs: 320px,
|
||||
|
|
|
|||
|
|
@ -1,9 +1,8 @@
|
|||
$content-width: 740px !default;
|
||||
|
||||
@import "../../assets/fonts/open-sans/webfont.css";
|
||||
@import "../../assets/fonts/open-sans-condensed/webfont.css";
|
||||
@import "../../assets/fonts/noto-serif/webfont.css";
|
||||
@import "../../assets/fonts/fira-mono/webfont.css";
|
||||
@import "../color_schemes/opensearch.scss";
|
||||
|
||||
// Font Family Mixins
|
||||
@mixin serif {
|
||||
|
|
@ -37,10 +36,6 @@ $content-width: 740px !default;
|
|||
}
|
||||
}
|
||||
|
||||
// Additional variables
|
||||
$table-border-color: $grey-lt-300;
|
||||
$toc-width: 232px !default;
|
||||
|
||||
body {
|
||||
@include sans-serif;
|
||||
}
|
||||
|
|
@ -114,14 +109,6 @@ code {
|
|||
}
|
||||
}
|
||||
|
||||
.div-feedback {
|
||||
text-align: center;
|
||||
margin: auto;
|
||||
width: 50%;
|
||||
border: 3px solid $grey-lt-300;
|
||||
padding: 10px;
|
||||
}
|
||||
|
||||
.external-arrow {
|
||||
position: relative;
|
||||
top: 0.125rem;
|
||||
|
|
@ -200,60 +187,80 @@ img {
|
|||
@include btn-color($white, $green-300);
|
||||
}
|
||||
|
||||
.btn-general {
|
||||
color: $blue-100;
|
||||
background-color: white;
|
||||
font-size: 0.9rem;
|
||||
font-weight: 510;
|
||||
border-width:1px;
|
||||
border-style:solid;
|
||||
border-color: $blue-100;
|
||||
border-radius: 5px;
|
||||
box-shadow: 1px 1px $grey-lt-300;
|
||||
padding: 0.5rem 1rem;
|
||||
margin-left: 0.4rem;
|
||||
margin-right: 0.4rem;
|
||||
transition: 0.3s;
|
||||
&:hover {
|
||||
&:not([disabled]) {
|
||||
background-color: #EAF4F9;
|
||||
box-shadow: 1px 2px 4px $grey-lt-300;
|
||||
transform: translateY(-1px);
|
||||
text-decoration:underline;
|
||||
text-underline-offset: 2px;
|
||||
display:inline-block;
|
||||
}
|
||||
&:active {
|
||||
transform: translateY(1px);
|
||||
}
|
||||
}
|
||||
&:disabled {
|
||||
color: mix(black, $base-button-color, 25%);
|
||||
border: none;
|
||||
cursor: default;
|
||||
background-color: mix(white, $base-button-color, 75%);
|
||||
box-shadow: none;
|
||||
}
|
||||
}
|
||||
|
||||
// Back to top button
|
||||
.top-link {
|
||||
display: block;
|
||||
color: $grey-dk-000;
|
||||
font-size: 2rem;
|
||||
font-weight: bold;
|
||||
width: 2.5rem;
|
||||
height: 2.5rem;
|
||||
color: $blue-dk-100;
|
||||
border-width:2px;
|
||||
border-style:solid;
|
||||
border-color: $grey-lt-300;
|
||||
border-radius: 12px;
|
||||
border-radius: 10px;
|
||||
box-shadow: 1px 2px 3px $grey-lt-300;
|
||||
padding: 0.1rem 1rem;
|
||||
padding: 0.2rem;
|
||||
position: fixed;
|
||||
bottom: 30px;
|
||||
right: 40px;
|
||||
right: 16px;
|
||||
z-index: 1;
|
||||
svg {
|
||||
transform: rotate(-90deg);
|
||||
}
|
||||
&:hover {
|
||||
border-color: $grey-dk-000;
|
||||
background-color: $sidebar-color;
|
||||
color: $body-text-color;
|
||||
border-color: $blue-dk-100;
|
||||
background-color: $sidebar-color;
|
||||
color: $blue-100;
|
||||
}
|
||||
}
|
||||
|
||||
.copy-button-wrap {
|
||||
background-color: $sidebar-color;
|
||||
padding: 0.2rem 2rem;
|
||||
padding: 0 2rem 0.5rem 2rem;
|
||||
display: flex;
|
||||
justify-content: flex-end;
|
||||
}
|
||||
|
||||
// Copy code button
|
||||
.copy-button {
|
||||
@extend .btn-general;
|
||||
background-color: $sidebar-color;
|
||||
display: inline;
|
||||
background-color: $base-button-color;
|
||||
color: $body-text-color;
|
||||
border-width: 1px;
|
||||
border-style: solid;
|
||||
border-color: $grey-lt-300;
|
||||
border-radius: 12px;
|
||||
height: fit-content;
|
||||
cursor: pointer;
|
||||
font-size: 1rem;
|
||||
padding: 0.2rem 0.4rem;
|
||||
margin: 0.4rem 0.2rem;
|
||||
opacity: 0.7;
|
||||
&:hover {
|
||||
border-color: $body-text-color;
|
||||
opacity: 1;
|
||||
}
|
||||
}
|
||||
|
||||
.copy-button:active {
|
||||
transform: scale(0.98);
|
||||
box-shadow: 0 1px 2px;
|
||||
}
|
||||
|
||||
// Copy as curl button
|
||||
|
|
@ -261,41 +268,26 @@ img {
|
|||
@extend .copy-button;
|
||||
}
|
||||
|
||||
.copy-curl-button:active {
|
||||
transform: scale(0.98);
|
||||
box-shadow: 0 1px 2px;
|
||||
}
|
||||
|
||||
// Feedback buttons
|
||||
.feedback-button {
|
||||
color: $body-text-color;
|
||||
background-color: $sidebar-color;
|
||||
font-size: 0.9rem;
|
||||
border-width:2px;
|
||||
border-style:solid;
|
||||
border-color: $grey-lt-300;
|
||||
border-radius: 12px;
|
||||
box-shadow: 1px 2px $grey-dk-000;
|
||||
padding: 0.1rem 1rem;
|
||||
margin-left: 0.4rem;
|
||||
margin-right: 0.4rem;
|
||||
width: 4.8rem;
|
||||
transition-duration: 0.4s;
|
||||
&:hover {
|
||||
background-color: $base-button-color;
|
||||
}
|
||||
@extend .btn-general;
|
||||
margin-left: 0.2rem;
|
||||
margin-right: 0.2rem;
|
||||
}
|
||||
|
||||
// Feedback question
|
||||
.feedback-header {
|
||||
@include heading-sans-serif;
|
||||
font-weight: 700;
|
||||
letter-spacing: 0.1em;
|
||||
margin-top: 1rem;
|
||||
margin-bottom: 2.5rem;
|
||||
font-size: 14px !important;
|
||||
@extend %toc-font;
|
||||
letter-spacing: 0.08em;
|
||||
margin-top: 1rem;
|
||||
margin-bottom: 1rem;
|
||||
}
|
||||
|
||||
// Feedback confirmation
|
||||
|
||||
.hidden {
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
// Tables
|
||||
th,
|
||||
|
|
@ -336,23 +328,28 @@ p.label {
|
|||
|
||||
// Modifies margins in xl layout to support TOC
|
||||
.side-bar {
|
||||
@include mq(xl) {
|
||||
width: calc(#{$nav-width} + 1rem);
|
||||
@include mq(lg) {
|
||||
width: $nav-width;
|
||||
}
|
||||
}
|
||||
|
||||
.main {
|
||||
@include mq(lg) {
|
||||
max-width: calc(100% - #{$nav-width + $top-button-margin});
|
||||
}
|
||||
|
||||
@include mq(xl) {
|
||||
max-width: calc(100% - (#{$nav-width + $toc-width} + 4rem));
|
||||
max-width: calc(min(#{$max-content-width + $toc-width + $top-button-margin}, calc(100% - (#{$nav-width + $top-button-margin}))));
|
||||
}
|
||||
}
|
||||
|
||||
// Adds TOC to righthand side in xl layout
|
||||
// Adds TOC to right hand side in xl layout
|
||||
.main-content-wrap {
|
||||
max-width: 100%;
|
||||
min-width: 0;
|
||||
}
|
||||
|
||||
.toc-wrap {
|
||||
width: 0;
|
||||
display: none;
|
||||
|
||||
@include mq(xl) {
|
||||
|
|
@ -360,30 +357,37 @@ p.label {
|
|||
padding: 2rem 0;
|
||||
}
|
||||
}
|
||||
.toc {
|
||||
display: none;
|
||||
|
||||
.sticky-wrap {
|
||||
@include mq(xl) {
|
||||
z-index: 1;
|
||||
display: block;
|
||||
position: sticky;
|
||||
top: 2rem;
|
||||
width: $toc-width;
|
||||
}
|
||||
}
|
||||
|
||||
.toc {
|
||||
@include mq(xl) {
|
||||
max-height: calc(100vh - 4rem);
|
||||
overflow: auto;
|
||||
}
|
||||
}
|
||||
|
||||
%toc-font {
|
||||
@include heading-sans-serif;
|
||||
text-transform: uppercase;
|
||||
font-weight: bold;
|
||||
letter-spacing: 0.1em;
|
||||
margin-top: 1rem;
|
||||
margin-bottom: 1rem;
|
||||
font-size: 14px !important;
|
||||
}
|
||||
|
||||
.toc-list {
|
||||
&:before {
|
||||
content: "On this page";
|
||||
// Basically duplicates h4 styling
|
||||
font-size: 12px;
|
||||
font-weight: 300;
|
||||
text-transform: uppercase;
|
||||
letter-spacing: 0.1em;
|
||||
color: $grey-dk-300;
|
||||
line-height: 1.8;
|
||||
@extend %toc-font;
|
||||
}
|
||||
border: 1px solid $border-color;
|
||||
font-size: 14px;
|
||||
|
|
@ -391,7 +395,7 @@ p.label {
|
|||
background-color: $sidebar-color;
|
||||
padding: $sp-6 $sp-4;
|
||||
margin-left: $sp-6;
|
||||
margin-right: 0;
|
||||
margin-right: $sp-6;
|
||||
margin-bottom: 0;
|
||||
overflow: auto;
|
||||
}
|
||||
|
|
@ -401,6 +405,18 @@ p.label {
|
|||
padding-bottom: .25rem;
|
||||
}
|
||||
|
||||
.div-feedback {
|
||||
@extend .table-wrapper;
|
||||
width: calc(#{$toc-width} - 4rem);
|
||||
text-align: center;
|
||||
margin-top: 3rem;
|
||||
margin-left: $sp-6;
|
||||
margin-right: $sp-6;
|
||||
padding-left: 1rem;
|
||||
padding-right: 1rem;
|
||||
display: block;
|
||||
}
|
||||
|
||||
/* Website Header & Footer */
|
||||
$logo_width: 170px;
|
||||
|
||||
|
|
|
|||
|
|
@ -2,12 +2,31 @@ const feedbackButtons = document.querySelectorAll('.feedback-button');
|
|||
|
||||
feedbackButtons.forEach((button) => {
|
||||
button.addEventListener('click', function onClick(event) {
|
||||
var url = window.location.href;
|
||||
console.log(url);
|
||||
console.log(button.value);
|
||||
gtag('event', 'feedback', {
|
||||
'event_category': url,
|
||||
'event_action': button.value
|
||||
gtag('event', 'feedback_click', {
|
||||
'helpful': button.value
|
||||
});
|
||||
// find the hidden feedback text
|
||||
sibling = button.nextElementSibling;
|
||||
|
||||
while (!(sibling.classList.contains('text-small') && sibling.classList.contains('hidden'))) {
|
||||
sibling = sibling.nextElementSibling;
|
||||
}
|
||||
// show the hidden feedback text
|
||||
if (sibling != null) {
|
||||
sibling.classList.remove('hidden');
|
||||
}
|
||||
|
||||
// disable the feedback buttons
|
||||
button.disabled = true;
|
||||
var buttonSibling;
|
||||
if (button.id === 'yes') {
|
||||
buttonSibling = button.nextElementSibling;
|
||||
}
|
||||
else {
|
||||
buttonSibling = button.previousElementSibling;
|
||||
}
|
||||
if (buttonSibling != null) {
|
||||
buttonSibling.disabled = true;
|
||||
}
|
||||
});
|
||||
});
|
||||
|
|
|
|||
|
|
@ -0,0 +1,13 @@
|
|||
const feedbackIssueLinks = document.querySelectorAll('.feedback-issue');
|
||||
addLinkListener(feedbackIssueLinks, 'submit_issue_click');
|
||||
|
||||
const feedbackEditLinks = document.querySelectorAll('.feedback-edit');
|
||||
addLinkListener(feedbackEditLinks, 'edit_page_click');
|
||||
|
||||
function addLinkListener(links, eventName) {
|
||||
links.forEach((link) => {
|
||||
link.addEventListener('click', function onClick(event) {
|
||||
gtag('event', eventName);
|
||||
});
|
||||
});
|
||||
}
|
||||
Loading…
Reference in New Issue