diff --git a/_ext/imagetarget.py b/_ext/imagetarget.py new file mode 100644 index 000000000..8132625ae --- /dev/null +++ b/_ext/imagetarget.py @@ -0,0 +1,96 @@ +# $Id$ +# Author: David Goodger +# Copyright: This module has been placed in the public domain. + +""" +Directives for figures and simple images. +""" + +__docformat__ = 'reStructuredText' + + +import sys +from docutils import nodes, utils +from docutils.parsers.rst import Directive +from docutils.parsers.rst import directives, states +from docutils.nodes import fully_normalize_name, whitespace_normalize_name +from docutils.parsers.rst.roles import set_classes + + +class imagetarget(Directive): + + align_h_values = ('left', 'center', 'right') + align_v_values = ('top', 'middle', 'bottom') + align_values = align_v_values + align_h_values + + def align(argument): + # This is not callable as self.align. We cannot make it a + # staticmethod because we're saving an unbound method in + # option_spec below. + return directives.choice(argument, imagetarget.align_values) + + required_arguments = 1 + optional_arguments = 0 + final_argument_whitespace = True + option_spec = {'alt': directives.unchanged, + 'height': directives.length_or_unitless, + 'width': directives.length_or_percentage_or_unitless, + 'scale': directives.percentage, + 'align': align, + 'target': directives.unchanged_required, + 'class': directives.class_option} + + def run(self): + if 'align' in self.options: + if isinstance(self.state, states.SubstitutionDef): + # Check for align_v_values. + if self.options['align'] not in self.align_v_values: + raise self.error( + 'Error in "%s" directive: "%s" is not a valid value ' + 'for the "align" option within a substitution ' + 'definition. Valid values for "align" are: "%s".' + % (self.name, self.options['align'], + '", "'.join(self.align_v_values))) + elif self.options['align'] not in self.align_h_values: + raise self.error( + 'Error in "%s" directive: "%s" is not a valid value for ' + 'the "align" option. Valid values for "align" are: "%s".' + % (self.name, self.options['align'], + '", "'.join(self.align_h_values))) + messages = [] + reference = directives.uri(self.arguments[0]) + self.options['uri'] = reference + reference_node = None + if 'target' in self.options: + block = states.escape2null( + self.options['target']).splitlines() + block = [line for line in block] + target_type, data = self.state.parse_target( + block, self.block_text, self.lineno) + if target_type == 'refuri': + reference_node = nodes.reference(refuri=data) + elif target_type == 'refname': + reference_node = nodes.reference( + refname=fully_normalize_name(data), + name=whitespace_normalize_name(data)) + reference_node.indirect_reference_name = data + self.state.document.note_refname(reference_node) + else: # malformed target + messages.append(data) # data is a system message + del self.options['target'] + set_classes(self.options) + imagetarget_node = nodes.image(self.block_text, **self.options) + if reference_node: + reference_node += imagetarget_node + return messages + [reference_node] + else: + return messages + [imagetarget_node] + +def setup(app): + app.add_directive("imagetarget", imagetarget) + + return { + 'version': '1.0', + 'parallel_read_safe': True, + 'parallel_write_safe': True, + } \ No newline at end of file diff --git a/_static/signalfx-includes.css b/_static/signalfx-includes.css index c0d04e2fa..43bd6503f 100755 --- a/_static/signalfx-includes.css +++ b/_static/signalfx-includes.css @@ -212,9 +212,9 @@ color:#0B599D !important; text-decoration:none; } -a:hover { -opacity:0.5; -text-decoration:none; +a.reference:hover { +opacity: .5; +text-decoration: none; } a:active { diff --git a/alerts-detectors-notifications/alert-message-variables-reference.rst b/alerts-detectors-notifications/alert-message-variables-reference.rst index 15836cb13..2258c01fb 100644 --- a/alerts-detectors-notifications/alert-message-variables-reference.rst +++ b/alerts-detectors-notifications/alert-message-variables-reference.rst @@ -8,6 +8,7 @@ The following tables describe the variables and helper functions you can use whe .. Note:: :ref:`Different additional variables may be available` depending on the alert condition you specify. If you change the alert condition after customizing the message, an icon on the Message preview tab appears. .. image:: /_images/images-detectors-alerts/message-tab-icon.png + :width: 20% :alt: This image shows the message tab icon. This is to remind you to review the message, since some variables you used might no longer apply to the new condition you selected. The icon is removed when you navigate away from the Message preview tab. diff --git a/conf.py b/conf.py index dd8b7fc2e..6bb4b3bc9 100644 --- a/conf.py +++ b/conf.py @@ -21,8 +21,10 @@ 'optimizer', 'myst_parser', 'sphinx_tabs.tabs', - 'sphinxcontrib.mermaid', - 'olly_on_git_hub' + 'olly_on_git_hub', + 'sphinxcontrib.images', + 'imagetarget', + 'sphinxcontrib.mermaid' ] html_context = { @@ -104,6 +106,12 @@ linkcheck_exclude_documents = [r'_.*', r'\.github', r'myst_parser', r'tests'] linkcheck_ignore = [r'https://ingest.*',r'https://app.*',r'https://login.*',r'.*\<.*',r'https://api.*',r'https://rum-ingest.*',r'https://proxy.*',r'https://example.*', r'https://domain.com.*', r'.*domain/path.*', r'.*signalfx.com.*', r'.*your_realm.*', r'.*your_domain.*'] +# Image settings + +images_config = { + 'override_image_directive': True +} + # ROLES AND MACROS ####################### @@ -124,7 +132,7 @@ ⋮ -.. |takeshift| image:: /_images/incident-intelligence/Incident-intelligence-take-shift-icon.png +.. |takeshift| imagetarget:: /_images/incident-intelligence/Incident-intelligence-take-shift-icon.png :alt: Take shift :class: inline-image diff --git a/gdi/opentelemetry/install-linux.rst b/gdi/opentelemetry/install-linux.rst index 6796bf2d4..e91be1d47 100644 --- a/gdi/opentelemetry/install-linux.rst +++ b/gdi/opentelemetry/install-linux.rst @@ -7,7 +7,7 @@ Install the Collector for Linux with the installer script .. meta:: :description: Describes how to install the Splunk Distribution of OpenTelemetry Collector for Linux using the script or deployment tools. -The Splunk Distribution of OpenTelemetry Collector for Linux is a package that provides integrated collection and forwarding for all data types. +The Splunk Distribution of OpenTelemetry Collector for Linux is a package that provides integrated collection and forwarding for all data types. Install the package using one of these methods: @@ -25,7 +25,7 @@ The following Linux distributions and versions are supported: * Amazon Linux: 2, 2023. Log collection with Fluentd is not currently supported for Amazon Linux 2023. * CentOS, Red Hat, or Oracle: 7, 8, 9 * Debian: 9, 10, 11 -* SUSE: 12, 15 for versions v0.34.0 or higher. Log collection with Fluentd is not currently supported. +* SUSE: 12, 15 for version 0.34.0 or higher. Log collection with Fluentd is not currently supported. * Ubuntu: 16.04, 18.04, 20.04, and 22.04 The installer script deploys and configures these elements: @@ -36,7 +36,7 @@ The installer script deploys and configures these elements: To install the package using the installer script, follow these steps: #. Ensure you have systemd, ``curl`` and ``sudo`` installed. -#. Download and execute the installer script. +#. Download and run the installer script. #. Replace the following variables for your environment: * ``SPLUNK_REALM``: This is the Realm to send data to. The default is ``us0``. See :new-page:`realms `. @@ -48,17 +48,8 @@ To install the package using the installer script, follow these steps: curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh; sudo sh /tmp/splunk-otel-collector.sh --realm $SPLUNK_REALM --memory $SPLUNK_MEMORY_TOTAL_MIB -- $SPLUNK_ACCESS_TOKEN -.. note:: If you have a Log Observer entitlement or wish to collect logs for the target host with Fluentd, use the ``--with-fluentd`` option to also install Fluentd when installing the Collector. +.. note:: If you have a Log Observer entitlement or want to collect logs for the target host with Fluentd, use the ``--with-fluentd`` option to also install Fluentd when installing the Collector. -Run additional script options -------------------------------------------- - -To display additional configuration options supported by the script, use the ``-h`` flag. - -.. code-block:: bash - - curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh; - sh /tmp/splunk-otel-collector.sh -h Configure memory allocation ---------------------------------- @@ -76,7 +67,7 @@ Configure proxy settings To configure proxy settings to install and run the OpenTelemetry Collector, see :ref:`configure-proxy-collector`. -Use configured repos +Use configured repos -------------------------------- By default, apt/yum/zypper repo definition files are created to download the package and Fluentd deb/rpm packages from @@ -89,6 +80,7 @@ To skip these steps and use configured repos on the target system that provide t curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \ sudo sh /tmp/splunk-otel-collector.sh --realm $SPLUNK_REALM --skip-collector-repo --skip-fluentd-repo \ -- $SPLUNK_ACCESS_TOKEN + .. _fluentd-manual-config-linux: @@ -142,14 +134,14 @@ Note the following: After any configuration modification, run ``sudo systemctl restart td-agent`` to restart the td-agent service. -If the td-agent package is upgraded after initial installation, you might need to set the Linux capabilities for the new version by performing the following steps for td-agent versions 4.1 or later: +If the td-agent package is upgraded after initial installation, you might need to set the Linux capabilities for the new version by performing the following steps for td-agent versions 4.1 or higher: #. Check for the activated capabilities: .. code-block:: bash sudo /opt/td-agent/bin/fluent-cap-ctl --get -f /opt/td-agent/bin/ruby - Capabilities in '/opt/td-agent/bin/ruby', + Capabilities in `` /opt/td-agent/bin/ruby`` , Effective: dac_override, dac_read_search Inheritable: dac_override, dac_read_search Permitted: dac_override, dac_read_search @@ -164,14 +156,136 @@ If the td-agent package is upgraded after initial installation, you might need t sudo systemctl restart td-agent -If you already installed Fluentd on a host, install the Collector without Fluentd using the ``--without-fluentd`` option. For more information, see :ref:`otel-configuration`. +If you already installed Fluentd on a host, install the Collector without Fluentd using the ``--without-fluentd`` option. For more information, see :ref:`otel-configuration`. .. _configure-auto-instrumentation: Configure automatic instrumentation for Java -------------------------------------------- -You can also automatically instrument your Java applications along with the Collector installation. Auto instrumentation removes the need to install and configure the Java agent separately. See :ref:`auto-instrumentation-java` for the installation instructions. For more information on Java instrumentation, see :ref:`get-started-java`. +You can also automatically instrument your Java applications along with the Collector installation. Auto instrumentation removes the need to install and configure the Java agent separately. See :ref:`auto-instrumentation-java` for the installation instructions. For more information on Java instrumentation, see :ref:`get-started-java`. + + + +.. _otel-installer-options-linux: + +Options of the installer script for Linux +================================================================== + +The Linux installer script supports the following options: + +.. list-table:: + :header-rows: 1 + :width: 100% + :widths: 30 40 30 + + * - Option + - Description + - Default value + * - ``--api-url `` + - Set the API endpoint URL explicitly instead of using the endpoint inferred from the specified realm. + - ``https://api.REALM.signalfx.com`` + * - ``--ballast `` + - Set the ballast size explicitly instead of the value calculated using the ``--memory`` option. See :ref:`otel-sizing` for more information. + - ``512`` + * - ``--beta`` + - Use the beta package repository. + - Not applicable + * - ``--collector-config `` + - Set the path to an existing custom configuration file for the Collector service instead of using the default configuration file provided by the Collector package based on the ``--mode `` option. If the specified file requires custom environment variables, you can manually add both the variables and values to ``$collector_env_path`` after installation. Restart the Collectorservice with the ``sudo systemctl restart splunk-otel-collector`` command for the changes to take effect. + - + * - ``--collector-version `` + - The Collector package version to install. + - ``$default_collector_version`` + * - ``--discovery`` + - Activate discovery mode on Collector startup. See :ref:`discovery_mode` for more information. + - Deactivated + * - ``--hec-token `` + - Set the HEC token if it`` s different than the specified ``access_token``. + - + * - ``--hec-url `` + - Set the HEC endpoint URL explicitly instead of using the endpoint inferred from the specified realm. + - ``https://ingest.REALM.signalfx.com/v1/log`` + * - ``--ingest-url `` + - Set the ingest endpoint URL explicitly instead of using the endpoint inferred from the specified realm. + - ``https://ingest.REALM.signalfx.com`` + * - ``--memory `` + - Total memory in MIB to allocate to the Collector. This option automatically calculates the ballast size. See :ref:`otel-sizing` for more information. + - ``$default_memory_size`` + * - ``--mode `` + - Configure the Collector service to run in host monitoring (``agent``) or data forwarding (``gateway``) mode. See :ref:`otel-deployment-mode` for more information. + - ``agent`` + * - ``--listen-interface `` + - Network interface the Collector receivers listen on. + - ``$default_listen_interface`` + * - ``--realm `` + - The Splunk realm to use. The ingest, API, trace, and HEC endpoint URLs are automatically generated using this value. + - ``$default_realm`` + * - ``--service-group `` + - Set the group for the splunk-otel-collector service. The option creates the group if it doesn't exist. + - ``$default_service_group`` + * - ``--service-user `` + - Set the user for the splunk-otel-collector service. The option creates the user if it doesn`t exist. + - ``$default_service_user`` + * - ``--skip-collector-repo`` + - By default, the scripts create an apt, yum, or zypper repo definition file to download the Collector package from ``$repo_base``. Use this option to skip the previous step and use a configured repo on the target system that provides the splunk-otel-collector deb or rpm package. + - + * - ``--skip-fluentd-repo`` + - By default, the scripts create an apt, yum, or zypper repo definition file to download the fluentd package from ``$td_agent_repo_base``. Use this option to skip the previous step and use a configured repo on the target system that provides the splunk-otel-collector deb or rpm package. + - + * - ``--test`` + - Use the test package repo. + - Not applicable + * - ``--trace-url `` + - Set the trace endpoint URL explicitly instead of the endpoint inferred from the specified realm. + - ``https://ingest.REALM.signalfx.com/v2/trace`` + * - ``--uninstall`` + - Removes the Splunk OpenTelemetry Collector for Linux. + - Not applicable + * - ``--with[out]-fluentd`` + - Whether to install and configure fluentd to forward log events to the Collector. See :ref:`fluentd-manual-config-linux` for more information. + - ``--without-fluentd`` + * - ``--with[out]-instrumentation`` + - Whether to install and configure the splunk-otel-auto-instrumentation package. See :ref:`zero-config` for more information. + - ``--without-instrumentation`` + * - ``--deployment-environment `` + - Set the ``deployment.environment`` resource attribute to the specified value. Only applicable if the ``--with-instrumentation`` option is also specified. + - Empty + * - ``--service-name `` + - Override the autogenerated service names for all instrumented Java applications on this host with ````. Only applicable if the ``--with-instrumentation`` option is also specified. + - Empty + * - ``--[no-]generate-service-name`` + - Specify ``--no-generate-service-name`` to prevent the preloader from setting the ``OTEL_SERVICE_NAME`` environment variable. Only applicable if the ``--with-instrumentation`` option is also specified. + - ``--generate-service-name`` + * - ``--[activate|disable]-telemetry`` + - Activate or deactivate the instrumentation preloader from sending the ``splunk.linux-autoinstr.executions`` metric to the Collector. Only applicable if the ``--with-instrumentation`` option is also specified. + - ``--activate-telemetry`` + * - ``--[activate|disable]-profiler`` + - Activate or deactivate AlwaysOn CPU Profiling. Only applicable if the ``--with-instrumentation`` option is also specified. + - ``--disable-profiler`` + * - ``--[activate|disable]-profiler-memory`` + - Activate or deactivate AlwaysOn Memory Profiling. Only applicable if the ``--with-instrumentation`` option is also specified. + - ``--disable-profiler-memory`` + * - ``--[activate|disable]-metrics`` + - Activate or deactivate exporting Micrometer metrics. Only applicable if the ``--with-instrumentation`` option is also specified. + - ``--disable-metrics`` + * - ``--instrumentation-version`` + - The package version to install. Only applicable if the ``--with-instrumentation`` option is also specified. + - ``$default_instrumentation_version`` + * - ``--`` + - Use ``--`` if the access token starts with ``-`` . + - Not applicable + +To display all the configuration options supported by the script, use the ``-h`` flag. + +.. code-block:: bash + + curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh; + sh /tmp/splunk-otel-collector.sh -h + + + + .. _linux-deployments: @@ -223,7 +337,7 @@ The Splunk Distribution of OpenTelemetry Collector for Heroku is a buildpack for Nomad ----------------- -Use Nomad to to deploy the Collector. See :ref:`deployments-nomad` for the installation instructions. +Use Nomad to deploy the Collector. See :ref:`deployments-nomad` for the installation instructions. .. _linux-pcf: @@ -233,7 +347,7 @@ Pivotal Cloud Foundry You can use one of these three options to deploy the Collector with Pivotal Cloud Foundry (PCF): * Collector standalone deployment. -* Collector as a sidecar to your app. +* Collector as a sidecar to your app. * Tanzu Tile. See more in :ref:`deployments-pivotal-cloudfoundry`. @@ -250,12 +364,13 @@ Salt --------------- Splunk provides a Salt formula to install and configure the Collector. See :ref:`deployments-salt` for the instructions. + Next steps ================================== -After you've installed the package, you can perform these actions: +After you`` ve installed the package, you can perform these actions: * :ref:`Configure the Collector `. * Use :ref:`Infrastructure Monitoring ` to track the health of your infrastructure. * Use :ref:`APM ` to monitor the performance of applications. -* Use :ref:`Log Observer Connect ` to analyze log events and troubleshoot issues with your services. +* Use :ref:`Log Observer Connect ` to analyze log events and troubleshoot issues with your services. \ No newline at end of file diff --git a/gdi/opentelemetry/install-windows.rst b/gdi/opentelemetry/install-windows.rst index 62ed557fb..10fb60e56 100644 --- a/gdi/opentelemetry/install-windows.rst +++ b/gdi/opentelemetry/install-windows.rst @@ -71,14 +71,15 @@ To install the package using the installer script, follow these steps: & {Set-ExecutionPolicy Bypass -Scope Process -Force; $script = ((New-Object System.Net.WebClient).DownloadString('https://dl.signalfx.com/splunk-otel-collector.ps1')); $params = @{access_token = "SPLUNK_ACCESS_TOKEN"; realm = "SPLUNK_REALM"}; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))} -.. note:: If needed, activate TLS in PowerShell using the following command: +.. note:: If needed, activate TLS in PowerShell using the following command: ``[Net.ServicePointManager]::SecurityProtocol = [Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls12`` + Configure memory allocation ---------------------------------- -To configure memory allocation, use the ``memory`` parameter. +To configure memory allocation, use the ``memory`` parameter. By default, the Collector is configured to use 512 MB (500 x 2^20 bytes) of memory. To increase this setting to allocate more memory, replace ``SPLUNK_MEMORY_TOTAL_MIB`` with the desired integer value. @@ -140,14 +141,94 @@ After any configuration modification, apply the changes by restarting the system Start the Collector executable manually ------------------------------------------- -If you experience unexpected start failures, try to start the Collector executable manually. +If you experience unexpected start failures, try to start the Collector executable manually. -To do so, run the following PowerShell command as an Admin: +To do so, run the following PowerShell command as an Admin: .. code-block:: PowerShell & 'C:\Program Files\Splunk\OpenTelemetry Collector\otelcol.exe' --config 'C:\ProgramData\Splunk\OpenTelemetry Collector\agent_config.yaml' + +.. _otel-installer-options-windows: + +Options of the installer script for Windows +==================================================== + +The Windows installer script supports the following options: + +.. list-table:: + :header-rows: 1 + :width: 100% + :widths: 30 40 30 + + * - Option + - Description + - Default value + * - ``access_token`` + - The token used to send metric data to Splunk. + - + * - ``realm`` + - The Splunk realm to use. The ingest, API, trace, and HEC endpoint URLs are automatically created using this value. + - ``us0`` + * - ``memory`` + - Total memory in MIB to allocate to the Collector. Automatically calculates the ballast size. See :ref:`otel-sizing` for more information. + - ``512`` + * - ``mode`` + - Configure the Collectorservice to run in host monitoring (``agent``) or data forwarding (``gateway``). + - ``agent`` + * - ``network_interface`` + - The network interface the Collectorreceivers listen on. + - ``0.0.0.0`` + * - ``ingest_url`` + - Set the base ingest URL explicitly instead of the URL inferred from the specified realm. + - ``https://ingest.REALM.signalfx.com`` + * - ``api_url`` + - Set the base API URL explicitly instead of the URL inferred from the specified realm. + - ``https://api.REALM.signalfx.com`` + * - ``trace_url`` + - Set the trace endpoint URL explicitly instead of the endpoint inferred from the specified realm. + - ``https://ingest.REALM.signalfx.com/v2/trace`` + * - ``hec_url`` + - Set the HEC endpoint URL explicitly instead of the endpoint inferred from the specified realm. + - ``https://ingest.REALM.signalfx.com/v1/log`` + * - ``hec_token`` + - Set the HEC token if it's different than the specified Splunk access token. + - + * - ``with_fluentd`` + - Whether to install and configure fluentd to forward log events to the collector. See :ref:`fluentd-manual-config-windows` for more information. + - ``$false`` + * - ``with_dotnet_instrumentation`` + - Whether to install and configure .NET tracing to forward .NET application traces to the local collector. + - ``$false`` + * - ``deployment_env`` + - A system-wide environment tag used by .NET instrumentation. Sets the ``SIGNALFX_ENV`` environment variable. Ignored if ``-with_dotnet_instrumentation`` is set to ``false``. + - + * - ``bundle_dir`` + - The location of your Smart Agent bundle for monitor functionality. + - ``C:\Program Files\Splunk\OpenTelemetry Collector\agent-bundle`` + * - ``insecure`` + - If true then certificates aren't checked when downloading resources. + - ``$false`` + * - ``collector_version`` + - Specify a specific version of the Collector to install. + - Latest version available + * - ``stage`` + - The package stage to install from [``test``, ``beta``, ``release``]. + - ``release`` + * - ``collector_msi_url`` + - When installing the Collector, instead of downloading the package, use this local path to a Splunk OpenTelemetry Collector MSI package. If specified, the ``-collector_version`` and ``-stage`` parameters are ignored. + - ``https://dl.signalfx.com/splunk-otel-collector/`` |br| ``msi/release/splunk-otel-collector--amd64.msi`` + * - ``fluentd_msi_url`` + - Specify the URL to the Fluentd MSI package to install. + - ``https://packages.treasuredata.com/4/windows/td-agent-4.1.0-x64.msi`` + * - ``msi_path`` + - Specify a local path to a Splunk OpenTelemetry Collector MSI package to install instead of downloading the package. If specified, the ``-collector_version`` and ``-stage`` parameters will be ignored. + - + + + + .. _windows-deployments: Deployments @@ -178,10 +259,11 @@ Puppet ------------------------------- Splunk provides a Puppet module to install and configure the package. A module is a collection of resources, classes, files, definition, and templates. To learn how to download and customize the module, see :ref:`deployment-windows-puppet`. + Next steps ================================== -Once you have installed the package, you can perform these actions: +After you have installed the package, you can do the following: * :ref:`use-navigators-imm`. * View logs and errors in the Windows Event Viewer. Search for "view logs and errors" on :new-page:`Microsoft documentation site ` for more information. diff --git a/index.rst b/index.rst index 6d268cfca..83befe134 100644 --- a/index.rst +++ b/index.rst @@ -4,7 +4,7 @@ Welcome ********** -.. image:: _images/get-started/o11y-user-doc-hero-banner-v2.svg +.. imagetarget:: _images/get-started/o11y-user-doc-hero-banner-v2.svg :alt: Welcome :width: 97.3% :target: https://docs.splunk.com/Observability/get-started/o11y.html#nav-Get-started diff --git a/logs/raw-logs-display.rst b/logs/raw-logs-display.rst index ff7a7d76d..665c850f7 100644 --- a/logs/raw-logs-display.rst +++ b/logs/raw-logs-display.rst @@ -10,28 +10,27 @@ Browse logs in the logs table At the center of the Log Observer display is the logs table, which displays log records as they come in. The most recent logs appear at the beginning of the table. Scan the :guilabel:`Severity` to find important -severity levels, then click in the record line to see the record details. +severity levels, then select in the record line to see the record details. These features help you browse the logs table: * Load log records by scrolling the table. As you scroll, you see records for log events that occurred in the past. The logs table doesn't have a scrolling limit, so you can scroll to see the oldest records. - When new log records are available, a prompt displays the number of new log events, such as :strong:`693 new events`. Click it to see the most recent log results. + When new log records are available, a prompt displays the number of new log events, such as :strong:`693 new events`. Select it to see the most recent log results. You can now examine the currently displayed section of logs for as long as you want. If you see important data in a log record, continue scrolling in the table to find more occurrences. If you see repeated occurrences of log records with an :guilabel:`ERROR` severity value, you might have a problem in one of your systems. -* At the top top center of the logs table, find the button that displays the number of events in the table. - Click the button to refresh the table and return to the current, incoming stream of logs. +* At the top center of the logs table, find the button that displays the number of events in the table. + Select the button to refresh the table and return to the current, incoming stream of logs. * Sort the logs table by any column by clicking the title of that column or the sort icon next to it. * Display particular fields as column headers in the table by performing the following steps: - #. In the logs table header row, click the :guilabel:`Configure Table` gear icon. + #. In the logs table header row, select the :guilabel:`Configure Table` gear icon. #. On the Table Settings popup, select the fields you want to display. You can search for particular fields in the Search box. When finished, click :guilabel:`Apply Changes`. Each field you selected is now a column in the table. #. You can customize the logs table display by adjusting the column width or dragging and dropping columns to a new order. - diff --git a/requirements.txt b/requirements.txt index e9ba5c8b6..e0418d8d3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -34,6 +34,7 @@ sphinx-tabs==3.4.1 sphinxcontrib-applehelp==1.0.4 sphinxcontrib-devhelp==1.0.2 sphinxcontrib-htmlhelp==2.0.1 +sphinxcontrib-images==0.9.4 sphinxcontrib-jsmath==1.0.1 sphinxcontrib-qthelp==1.0.3 sphinxcontrib-serializinghtml==1.1.5