From e9b6f4fa42208f8c180726cf5b5a290f226171bc Mon Sep 17 00:00:00 2001 From: trangl Date: Thu, 14 Nov 2024 14:09:02 +0100 Subject: [PATCH 01/12] Remove duplicate contents --- data-visualization/charts/chart-types.rst | 268 ++++++++++++-------- data-visualization/charts/create-charts.rst | 188 +------------- 2 files changed, 165 insertions(+), 291 deletions(-) diff --git a/data-visualization/charts/chart-types.rst b/data-visualization/charts/chart-types.rst index dda86254a..220f90aa7 100644 --- a/data-visualization/charts/chart-types.rst +++ b/data-visualization/charts/chart-types.rst @@ -1,39 +1,46 @@ .. _chart-types: -***************************************** +*************************************************** Chart types in Splunk Observability Cloud -***************************************** +*************************************************** .. meta:: - :description: Learn about chart types in Splunk Observability Cloud + :description: Learn about different chart types and when to use each chart type in Splunk Observability Cloud -To learn more about how to work with each chart type, see :ref:`choose-chart-type`. This topic provides details about different chart types in Splunk Observability Cloud: +.. _charts-overview: + +Overview +==================== + +Charts in Splunk Observability Cloud are components of a dashboard. Each chart type provides a different way to represent your data: -- :ref:`line-charts`: Display data in a plot with data points connected by a series of straight lines. -- :ref:`area-charts`: Display in a plot similar to a line chart, except that the area below the line is filled. -- :ref:`column-charts`: Also known as bar charts. Each data point is displayed as a vertical bar going from the x-axis origin to the measured value of the data point. The bars aren't connected. -- :ref:`histogram-charts`: Display as horizontal rectangles on a two-dimensional plot. The starting and ending x-position of a rectangle represents the time duration over which data points for that rectangle were collected. The y-position of a rectangle represents the number of data points collected in that time duration. +- :ref:`graph-charts`: Display data points over a period of time. Graph charts come in four different forms. + - :ref:`line-charts`: Display data in a plot with data points connected by a series of straight lines. + - :ref:`area-charts`: Display in a plot similar to a line chart, except that the area below the line is filled. + - :ref:`column-charts`: Also known as bar charts. Display each data point as a vertical bar going from the x-axis origin to the measured value of the data point. The bars aren't connected. + - :ref:`histogram-charts`: Display as horizontal rectangles on a two-dimensional plot. The starting and ending x-position of a rectangle represents the time duration over which data points for that rectangle were collected. The y-position of a rectangle represents the number of data points collected in that time duration. - :ref:`list-charts`: Display multiple data points at each point in time. They show recent trends in the data, including up to 100 data points. -- :ref:`single-value-charts`: Show a single value for a data point as it changes over time. In most cases, you use this type of chart to display important metrics as a single number. -- :ref:`heatmap-charts`: Present a series of squares each representing a single data point of the selected metric. The color of each square represents the value range of the metric allowing quick identification of values that are higher or lower than desired. -- :ref:`event-feed-charts`: This chart type doesn't display metric data. Instead, it displays a list of events that meet the criteria you specify. -- :ref:`text-charts`: Text charts let you create a "chart" containing descriptive information. You can then add this chart to a dashboard to provide an introduction or instructions for other charts in the dashboard. -- :ref:`table-charts`: Display metrics and dimensions in table format. +- :ref:`single-value-charts`: Display a single value for a data point as it changes over time. In most cases, you use this type of chart to display important metrics as a single number. +- :ref:`heatmap-charts`: Display a series of squares each representing a single data point of the selected metric. The color of each square represents the value range of the metric allowing quick identification of values that are higher or lower than desired. +- :ref:`event-feed-charts`: Display a list of events instead of metric data. +- :ref:`text-charts`: Text charts let you create a "chart" containing descriptive information. Add this chart to a dashboard to provide an introduction or instructions for other charts in the dashboard. +- :ref:`table-charts`: Display metrics and dimensions in the table format. + +To learn more about selecting the appropriate charts in Splunk Observability Cloud, see the following sections for more description and example on each chart type. .. _graph-charts: Graph charts ============ -Graph charts appear as one or more plots of data over time. Each metric time series (MTS) in the chart -appears as a single plot, and each plot has its own color. -For example, a series of line plots for AWS MTS might be colored by their AWS availability zone -dimension, with red indicating ``us-east-1``, green indicating ``us-east-2``, and purple -indicating ``eu-west-1``. +Use graph charts when you want to display data points over a period of time. + +Each metric time series (MTS) in the chart appears as a single plot, and each plot has its own color. For example, a series of line plots for AWS MTS might be colored by their AWS availability zone dimension, with red indicating ``us-east-1``, green indicating ``us-east-2``, and purple indicating ``eu-west-1``. + Graph chart visualizations --------------------------- +---------------------------- Graph charts can have one of four forms: @@ -50,103 +57,62 @@ Line charts The line chart plot type appears as a series of straight lines that connect the data points in the MTS. + .. image:: /_images/data-visualization/charts/line-chart.png + :alt: This screenshot shows a line chart illustrating the CPU percentages used for a set of AWS EC2 instances. + + .. _area-charts: Area charts =========== -The area chart plot type appears as line chart with the area between the line -and the x-axis filled in with the color of the line. +The area chart plot type appears as line chart with the area between the line and the x-axis filled in with the color of the line. + + .. image:: /_images/data-visualization/charts/area-chart.png + :alt: This screenshot shows an area chart illustrating the CPU percentages used for a set of AWS EC2 instances. .. _column-charts: Column charts ============= -The column chart plot type appears as shaded vertical bars starting at the -x-axis and ending at the data point value. By default, each plot point is shown as an independent -bar. +The column chart plot type appears as shaded vertical bars starting at the x-axis and ending at the data point value. By default, each plot point is shown as an independent bar. + +You can also stack column charts. The bars representing each value appear as vertical stacks at the corresponding time value along the x-axis. -You can also stack column charts. The bars representing each value appear as vertical -stacks at the corresponding time value along the x-axis. + .. image:: /_images/data-visualization/charts/column-chart.png + :alt: This screenshot shows a column chart illustrating CPU percentages used for a set of AWS EC2 instances. .. _histogram-charts: Histogram charts ================ -Histograms appear as colored rectangular bins indicating how many plot points -are at that value. For example, a green bar might indicate a higher -density of plot points with the relevant value than a red bar. Alternatively, darker -shades of a single color might indicate a higher density of plot points -for a value than a lighter shade of that same color. - -The values of a histogram plot display in a random order by default. You -can organize them into two grouping levels to clarify the data. For example, you can group -data by AWS region or availability zone to make it easier to track performance -within each region or availability zone. - - -.. _single-value-charts: - -Single value charts -=================== +Histograms appear as colored rectangular bins indicating how many plot points are at that value. For example, a green bar might indicate a higher density of plot points with the relevant value than a red bar. Alternatively, darker shades of a single color might indicate a higher density of plot points for a value than a lighter shade of that same color. -Single value charts appear as a single value for a data point as it changes -over time. In most cases, you use this type of chart to display -important metrics as a single number. For example, use single value -charts in a summary dashboard shown on a wall TV. The dashboard can -display the number of active hosts, active processes, or number of -requests served in the past 24 hours. +The values of a histogram plot display in a random order by default. You can organize them into two grouping levels to clarify the data. For example, you can group data by AWS region or availability zone to make it easier to track performance within each region or availability zone. -You can highlight the value using specific colors based on thresholds. -For example, when the number of requests served over the past 24 hours -meets the daily goal, you can set the color of the value to change from -red to green. + .. image:: /_images/data-visualization/charts/histogram-chart.png + :alt: This screenshot shows a histogram chart illustrating CPU percentages used for a set of AWS EC2 instances. -If the input stream for a single value chart contains more than one MTS, -the chart displays the first MTS it detects in the stream and ignores -the others. - -Single value chart prefix and suffix ------------------------------------- - -To help describe the chart value, add prefix and suffix strings: - -- The ``valuePrefix`` property specifies a prefix string. -- The ``valueSuffix`` property specifies a suffix string. - -Single value chart secondary visualization ------------------------------------------- - -Secondary visualizations help you see trends in a single value chart: - -- :strong:`Sparkline`: Shows recent trends of the value -- :strong:`Radial`: Shows a dial that marks where the current value is among - the expected range of values -- :strong:`Linear`: Shows a bar that marks where the current value is among the expected range of values - -By default, a single value chart doesn't show any additional visualizations. .. _list-charts: List charts =========== -List charts are similar to single value charts, but they appear as -multiple data points for each point in time. +Use this chart type to display current data values in a list format. By default, the name of each value in the chart reflects the name of the plot and any associated analytics. To avoid having the raw metric name displayed on the chart, give the plot a meaningful name. A list chart can display up to 100 items at a time. + .. image:: /_images/data-visualization/charts/list-chart.png + :alt: This screenshot shows a list chart illustrating the number of active hosts per AWS EC2 instance type. + Sorting list charts ------------------- -The API lets you sort values in list charts by specifying the -``options.sortBy`` property in the request to create or update a chart. -You can sort on one of the dimensions in the MTS for the chart, a data point, the metric -name, or the ``publish()`` method ``label`` argument of the SignalFlow -statement that generates the data. To choose one of these options, you -specify one of the keyword values shown in the following table: +The API lets you sort values in list charts by specifying the ``options.sortBy`` property in the request to create or update a chart. +You can sort on one of the dimensions in the MTS for the chart, a data point, the metric name, or the ``publish()`` method ``label`` argument of the SignalFlow statement that generates the data. To choose one of these options, you specify one of the keyword values shown in the following table: .. list-table:: :header-rows: 1 @@ -177,12 +143,9 @@ In addition, you can sort by any dimension of an MTS displayed in the chart. To see a list of entities on which you can sort: #. In the user interface, open the chart. -#. Select the **Chart options** tab. -#. Open the **Sort** drop-down list. - -In the list, **Value** is the alias for ``value``, **Plot name** is the -alias for ``sf_metric``, and **Metric** is the alias for -``sf_originatingMetric``. All other list items are dimension names. +#. Select the :strong:`Chart options` tab. +#. Open the :strong:`Sort` dropdown list. In the list, :strong:`Value` is the alias for ``value``, :strong:`Plot name` is the +alias for ``sf_metric``, and :strong:`Metric`` is the alias for ``sf_originatingMetric``. All other list items are dimension names. :strong:`Examples` @@ -242,56 +205,151 @@ Secondary visualizations help you see trends in a list chart: the expected range of values - :strong:`Linear`: Shows a bar that marks where the current values are among the expected range of values +.. _single-value-charts: + +Single value charts +=================== + +Use this chart type when you want to see a single number in a large font that represents the value of a single data point on a plot line. In most cases, you use this type of chart to display important metrics as a single number. + +For example, use single value charts in a summary dashboard shown on a wall TV. The dashboard can display the number of active hosts, active processes, or number of requests served in the past 24 hours. + + .. image:: /_images/data-visualization/charts/single-value-chart.png + :width: 50% + :alt: This screenshot shows a single value chart illustrating the number of hosts with the Splunk Distribution of OpenTelemetry Collector installed. + +You can highlight the value using specific colors based on thresholds. For example, when the number of requests served over the past 24 hours meets the daily goal, you can set the color of the value to change from red to green. + +If the input stream for a single value chart contains more than one MTS, the chart displays the first MTS it detects in the stream and ignores the others. + + +Single value chart prefix and suffix +------------------------------------ + +To help describe the chart value, add prefix and suffix strings: + +- The ``valuePrefix`` property specifies a prefix string. +- The ``valueSuffix`` property specifies a suffix string. + +Single value chart secondary visualization +------------------------------------------ + +Secondary visualizations help you see trends in a single value chart: + +- :strong:`Sparkline`: Shows recent trends of the value +- :strong:`Radial`: Shows a dial that marks where the current value is among + the expected range of values +- :strong:`Linear`: Shows a bar that marks where the current value is among the expected range of values + +By default, a single value chart doesn't show any additional visualizations. + +Best practices for single value charts +------------------------------------------ + +* If multiple plots are marked as visible, the value represents the first visible plot in the list. For example, if plots |nbsp| A and |nbsp| B are visible, the value represents plot |nbsp| A. If you hide plot |nbsp| A, the value represents plot |nbsp| B. +* An especially useful option for this chart type is :ref:`color-value`, which lets you use different colors to represent different value ranges. + +.. caution:: + + To display an accurate value, the plot must use an aggregate analytics function that generates a single value for each data point on the chart, such as mean, sum, max, and so on. If the plot line always reflects only a single time series, no analytics function is needed. However, this is uncommon. + + If the plot line on the chart shows multiple values, that is one line per metric time series (MTS) when viewed as a line chart, the single number displayed on the chart might represent any of the values for a given point in time. + .. _heatmap-charts: Heatmap charts ============== -Heatmap charts appear as a series of squares, each representing a single -data point of the selected MTS. The color of each square represents -the value range of the data point. This helps you identify values -that are higher or lower than you expect. +Use heatmap charts when you want to see the specified plot in a format similar to the navigator view in Splunk Infrastructure Monitoring, with each square representing each source for the selected metric, and the color of each square representing the value range of the metric. + + .. image:: /_images/data-visualization/charts/heatmap-chart.png + :alt: This screenshot shows a heatmap chart illustrating the CPU capacity used by each node in a Kubernetes cluster. + +Heatmap charts help you identify values that are higher or lower than you expect. Heatmap chart grouping ----------------------- +------------------------ -To highlight the information for a specific aspect of your data, -group the data points. You can use up to two dimensions for the grouping. -For example, you can group CPU utilization by AWS availability zone as the -primary grouping dimension, and number of host CPU cores as the secondary grouping dimension. +To highlight the information for a specific aspect of your data, group the data points. You can use up to two dimensions for the grouping. +For example, you can group CPU utilization by AWS availability zone as the primary grouping dimension, and number of host CPU cores as the secondary grouping dimension. To help describe the values in the heatmap, add prefix and suffix strings: - The ``valuePrefix`` property specifies a prefix string. - The ``valueSuffix`` property specifies a suffix string. - .. _event-feed-charts: Event feed charts ================= -Event feed charts let you add a list of events to a dashboard. An event feed chart can display one or more event types depending how you specify the criteria. +Use this chart type when you want to see a list of events on your dashboard. An event feed chart can display one or more event types depending how you specify the criteria. + + .. image:: /_images/data-visualization/charts/event-feed-chart.png + :alt: This screenshot shows an event feed chart illustrating a series of cleared, critical, and custom events. + +To customize the information shown in the feed, see :ref:`dashboard-event-feed`. .. _text-charts: Text charts =========== -Text charts let you add textual information to a dashboard. The text -appears in the same type of panel that Splunk Observability Cloud uses to display data. +Use text charts when you want to place a text note on the dashboard instead of displaying metrics. The text appears in the same type of panel that Splunk Observability Cloud uses to display data. + + .. image:: /_images/data-visualization/charts/text-chart.png + :width: 50% + :alt: This screenshot shows a text chart illustrating how you can this chart type to provide relevant instructional text on a dashboard. Splunk Observability Cloud lets you use GitHub-style Markdown in your text. .. note:: Inserting images using Markdown is not supported in text charts. - .. _table-charts: Table charts ================= -A table chart displays metrics and dimensions in table format. Each metric name and dimension key displays as a column. Each output metric time series displays as a row. If there are multiple values for a cell, each time series displays in a separate row. +Use table charts when you want to see metrics and dimensions in table format. Each metric name and dimension key displays as a column. Each output metric time series displays as a row. If there are multiple values for a cell, each time series displays in a separate row. + + .. image:: /_images/data-visualization/charts/table-chart.png + :alt: This screenshot shows a table chart grouped by the demo_host dimension, sorted by the demo_customer dimension, and linked to a detector with no alerts as illustrated by a green border around the table chart. + +You can group metric time series rows by a dimension. To do this, select the :strong:`Group by` menu and select the dimension you want to group the rows by. The selected dimension's column becomes the first column and each row of the table displays to represent one value of the dimension. + +For example, group the table by the ``host`` dimension to display the health and status of each host in your environment. + +If you group by a dimension column that you've hidden, the column displays to accomplish the requested grouping. + +After using the :strong:`Group by` option to group the table, there might still be more than one row per dimension value. This can happen if there are multiple values for a column per grouping dimension value. To resolve this, you can apply aggregation analytics to plots. For more information about aggregation, see :ref:`aggregations-transformations`. + +If there are missing data values for a table cell, the cell displays no value. + +Here are some additional ways in which you can customize a table chart to best visualize your data: + +- Reorder a dimension column + + Select and drag the column header to move the column to its new position. You can't reorder metric columns. + +- Show or hide a column + + - In graphical Plot Editor view, select the gear icon near the upper right of the table. In the :strong:`SHOW/HIDE COLUMNS` section, select the column name to switch between showing and hiding the column. + + - In SignalFlow Plot Editor view: + + - To hide a metric column, comment it out by adding a :code:`#` to the start of the metric's line of SignalFlow code. Alternatively, you can remove the metric. + + - To show or hide a dimension column, select the gear icon near the upper right of the table. In the :strong:`SHOW/HIDE COLUMNS` section, select the dimension column name to switch between showing and hiding the column. + +- Sort table values + + Select a column header to switch between sorting by ascending and descending order. An arrow icon displays in the column header to indicate the sort order. + +- Link a detector to the table chart + + Select the :strong:`Alerts` icon (bell) near the upper right of the Chart Builder. Select :strong:`Link detector` to link the table chart to an existing detector. Select :strong:`New Detector From Chart` to create a new detector to link the table chart to. + + For more information about creating a new detector from a chart, see :ref:`create-detector-from-chart`. -For more information, see :ref:`table-chart-type`. + A chart that is linked to a detector displays with a border color that corresponds to the alert status of the linked detector. For example, if there are no alerts issued by the detector, the chart displays with a green border. The chart displays alerts in the chart header, but doesn't display alert status per row. diff --git a/data-visualization/charts/create-charts.rst b/data-visualization/charts/create-charts.rst index 164c3693d..865fa1042 100644 --- a/data-visualization/charts/create-charts.rst +++ b/data-visualization/charts/create-charts.rst @@ -118,199 +118,15 @@ Select a chart type Available chart types are shown as icons in the chart's title bar. You can also select a chart type in the Chart Options tab. Hover over an icon to see which chart type it represents, then select an icon to display the chart in that format. The selected chart type is highlighted and indicated by a small pointer. -To learn more about different chart types, see :ref:`chart-types`. - -See the following sections for more information on when to use each type of chart: - -- :ref:`graph-chart-type`. - -- :ref:`list-chart-type`. - -- :ref:`single-value-chart-type`. - -- :ref:`heatmap-chart-type`. -- :ref:`event-feed-chart-type`. - -- :ref:`text-chart-type`. - -- :ref:`table-chart-type`. +To learn more about different chart types, see :ref:`chart-types`. .. note:: In some cases, you might want to create multiple charts for the same data displayed in different ways. One way to do that is to copy a chart then change the chart type after you paste it from the clipboard. Another way is to change the chart type and then use :guilabel:`Save as` to save it as a new chart, preferably with a new name. See :ref:`copy-charts` for more information. -.. _graph-chart-type: - -Use graph charts ----------------- - -Use graph charts when you want to display data points over a period of time. To learn more about graph charts, see :ref:`graph-charts`. - -The first four icons in the chart's title bar represent the four visualization options for graph charts: - -- Line: To learn more about line visualization, see :ref:`line-charts`. - - .. image:: /_images/data-visualization/charts/line-chart.png - :alt: This screenshot shows a line chart illustrating the CPU percentages used for a set of AWS EC2 instances. - -- Area: To learn more about area visualization, see :ref:`area-charts`. - - .. image:: /_images/data-visualization/charts/area-chart.png - :alt: This screenshot shows an area chart illustrating the CPU percentages used for a set of AWS EC2 instances. - -- Column: To learn more about column visualization, see :ref:`column-charts`. - - .. image:: /_images/data-visualization/charts/column-chart.png - :alt: This screenshot shows a column chart illustrating CPU percentages used for a set of AWS EC2 instances. - -- Histogram: To learn more about histogram visualization, see :ref:`histogram-charts`. - - .. image:: /_images/data-visualization/charts/histogram-chart.png - :alt: This screenshot shows a histogram chart illustrating CPU percentages used for a set of AWS EC2 instances. - -The chart type you choose here is applied as a default to all the plots on the chart, but you can choose a different visualization type for individual plots. See :ref:`plot-config-panel`. - -To customize a chart, see :ref:`chart-options-tab`. - -.. _single-value-chart-type: - -Use single value charts ------------------------ - -Choose this chart type when you want to see a single number in a large font that represents the current value of a single data point on a plot line. If the time period is in the past, the number represents the value of the metric near the end of the time period. - - .. image:: /_images/data-visualization/charts/single-value-chart.png - :width: 50% - :alt: This screenshot shows a single value chart illustrating the number of hosts with the Splunk Distribution of OpenTelemetry Collector installed. - -.. caution:: - - To display an accurate value, the plot must use an aggregate analytics function that generates a single value for each data point on the chart, such as Mean, Sum, Max, and so on. If the plot line always reflects only a single time series, no analytics function is needed. However, this is uncommon. - - If the plot line on the chart shows multiple values, that is one line per metric time series (MTS) when viewed as a line chart, the single number displayed on the chart might represent any of the values for a given point in time. - - -.. note:: - - If multiple plots are marked as visible, the value represents the first visible plot in the list. For example, if plots |nbsp| A and |nbsp| B are visible, the value represents plot |nbsp| A. If you hide plot |nbsp| A, the value represents plot |nbsp| B. - -To learn more about single value charts, see :ref:`single-value-charts`. - -To customize a chart, see :ref:`chart-options-tab`. An especially useful option for this chart type is :ref:`color-value`, which lets you use different colors to represent different value ranges. - -.. _heatmap-chart-type: - -Use heatmap charts ------------------- - -Use heatmap charts when you want to see the specified plot in a format similar to the navigator view in Infrastructure Monitoring, with squares representing each source for the selected metric, and the color of each square representing the value range of the metric. - - .. image:: /_images/data-visualization/charts/heatmap-chart.png - :alt: This screenshot shows a heatmap chart illustrating the CPU capacity used by each node in a Kubernetes cluster. - -To learn more about heatmap charts, see :ref:`heatmap-charts`. - -To customize a chart, see :ref:`chart-options-tab`. - - -.. _list-chart-type: - -Use list charts ---------------- - -Use this chart type to display current data values in a list format. By default, the name of each value in the chart reflects the name of the plot and any associated analytics. To avoid having the raw metric name displayed on the chart, give the plot a meaningful name. - - .. image:: /_images/data-visualization/charts/list-chart.png - :alt: This screenshot shows a list chart illustrating the number of active hosts per AWS EC2 instance type. - -To learn more about list charts, see :ref:`list-charts`. - -To customize the information shown in the list, see :ref:`chart-options-tab`. - - -.. _event-feed-chart-type: - -Use event feed charts ---------------------- - -Use this chart type when you want to see a list of events on your dashboard. - - .. image:: /_images/data-visualization/charts/event-feed-chart.png - :alt: This screenshot shows an event feed chart illustrating a series of cleared, critical, and custom events. - -To learn more about event feed charts, see :ref:`event-feed-charts`. - -To customize the information shown in the feed, see :ref:`dashboard-event-feed`. - - -.. _text-chart-type: - -Use text charts ---------------- - -Use text charts when you want to place a text note on the dashboard instead of displaying metrics. - - .. image:: /_images/data-visualization/charts/text-chart.png - :width: 50% - :alt: This screenshot shows a text chart illustrating how you can this chart type to provide relevant instructional text on a dashboard. - -To learn more about text charts, see :ref:`text-charts`. - -See also :ref:`text-note`. - - -.. _table-chart-type: - -Use table charts ------------------------------- - -A table chart displays metrics and dimensions in table format. Each metric name and dimension key displays as a column. Each output metric time series displays as a row. If there are multiple values for a cell, each time series displays in a separate row. - -.. image:: /_images/data-visualization/charts/table-chart.png - :alt: This screenshot shows a table chart grouped by the demo_host dimension, sorted by the demo_customer dimension, and linked to a detector with no alerts as illustrated by a green border around the table chart. - -You can group metric time series rows by a dimension. To do this, select the :strong:`Group by` menu and select the dimension you want to group the rows by. The selected dimension's column becomes the first column and each row of the table displays to represent one value of the dimension. - -For example, group the table by the :code:`host` dimension to display the health and status of each host in your environment. - -If you choose to group by a dimension column that you've hidden, the column displays to accomplish the requested grouping. - -After using the :strong:`Group by` option to group the table, there might still be more than one row per dimension value. This can happen if there are multiple values for a column per grouping dimension value. To resolve this, you can apply aggregation analytics to plots. - -For more information about aggregation, see :ref:`aggregations-transformations`. - -If there are missing data values for a table cell, the cell displays no value. - -Here are some additional ways in which you can customize a table chart to best visualize your data: - -- Reorder a dimension column - - Select and drag the column header to move the column to its new position. You can't reorder metric columns. - -- Show or hide a column - - - In graphical Plot Editor view, select the gear icon near the upper right of the table. In the :strong:`SHOW/HIDE COLUMNS` section, select the column name to switch between showing and hiding the column. - - - In SignalFlow Plot Editor view: - - - To hide a metric column, comment it out by adding a :code:`#` to the start of the metric's line of SignalFlow code. Alternatively, you can remove the metric. - - - To show or hide a dimension column, select the gear icon near the upper right of the table. In the :strong:`SHOW/HIDE COLUMNS` section, select the dimension column name to switch between showing and hiding the column. - -- Sort table values - - Select a column header to switch between sorting by ascending and descending order. An arrow icon displays in the column header to indicate the sort order. - -- Link a detector to the table chart - - Select the :strong:`Alerts` icon (bell) near the upper right of the Chart Builder. Select :strong:`Link detector` to link the table chart to an existing detector. Select :strong:`New Detector From Chart` to create a new detector to link the table chart to. - - For more information about creating a new detector from a chart, see :ref:`create-detector-from-chart`. - - A chart that is linked to a detector displays with a border color that corresponds to the alert status of the linked detector. For example, if there are no alerts issued by the detector, the chart displays with a green border. The chart displays alerts in the chart header, but doesn't display alert status per row. +The chart type you select is applied as a default to all the plots on the chart, but you can use different visualizations for individual plots. To learn more, see :ref:`plot-config-panel`. -For more information about customizing charts, see :ref:`chart-options-tab`. Edit a chart From 3cf3498c9d3f0c4d00cc4bb7f98aee8c9c3a2fd1 Mon Sep 17 00:00:00 2001 From: trangl Date: Thu, 14 Nov 2024 14:17:17 +0100 Subject: [PATCH 02/12] Fix undefined labels --- data-visualization/charts/chart-builder.rst | 6 +++--- data-visualization/charts/chart-options.rst | 4 ++-- data-visualization/charts/chart-types.rst | 5 +++-- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/data-visualization/charts/chart-builder.rst b/data-visualization/charts/chart-builder.rst index 55c2f0a21..84ad6718f 100644 --- a/data-visualization/charts/chart-builder.rst +++ b/data-visualization/charts/chart-builder.rst @@ -299,7 +299,7 @@ Visibility of plot lines Click the eye icon on the far left of the plot line to show or hide the plot line on the chart. This option is not available for text charts and event feeds. In all chart types except heatmap, multiple plot lines can be displayed. -.. note:: In the :ref:`single-value-chart-type`, if multiple plots are visible, the value on the chart reflects the first visible plot in the plot list. +.. note:: In a single value chart, if multiple plots are visible, the value on the chart reflects the first visible plot in the plot list. To hide all plot lines except one, alt-click (or option-click) the eye icon for the plot line you want to display. This can be useful when a chart contains multiple plots and you need to focus on just one. To return to the previous view, alt-click the eye icon again for the visible plot line. @@ -391,7 +391,7 @@ A number displayed on a chart could be anything from a raw number (such as bits All display units are shown when you take any of the following actions: -- View a :ref:`single-value` or :ref:`list chart` +- View a :ref:`single value` or :ref:`list chart` - Look at values in the :ref:`data table` for a chart @@ -425,7 +425,7 @@ It can sometimes be useful to apply the :ref:`Scale` analytics function w Visualization type ------------------------------------------------------------------- -For :ref:`graphs`, plots default to a visualization style selected for the chart as a whole, such as line, area, column, or histogram. For example, new plots created on a column chart appear initially as additional columns. However, you can change this setting so a plot uses a different chart display type than the chart default. +For :ref:`graph charts`, plots default to a visualization style selected for the chart as a whole, such as line, area, column, or histogram. For example, new plots created on a column chart appear initially as additional columns. However, you can change this setting so a plot uses a different chart display type than the chart default. For example, if the chart is an area chart, you can choose to display one of its plots as a line. diff --git a/data-visualization/charts/chart-options.rst b/data-visualization/charts/chart-options.rst index 6909826d7..a28d4fe66 100644 --- a/data-visualization/charts/chart-options.rst +++ b/data-visualization/charts/chart-options.rst @@ -109,7 +109,7 @@ In the following illustration, the border on the left indicates that value is or Color theme ============================================================================= -Use this option to specify the color family to use when you populate a histogram chart. To learn more, see :ref:`graph-chart-type`. The color you select represents the darkest value on the chart; other values are shown with progressively less saturation. +Use this option to specify the color family to use when you populate a histogram chart. To learn more, see :ref:`graph-charts`. The color you select represents the darkest value on the chart; other values are shown with progressively less saturation. Similar options are available for heatmap charts (see :ref:`color-threshold`) and for single value and list charts. To learn more, see :ref:`color-value`. @@ -499,7 +499,7 @@ This option lets you specify whether Y-axis values are shown in decimal units (1 Visualization type ============================================================================= -See :ref:`choose-chart-type`. +See :ref:`chart-types`. .. _chart-option-compatibility-matrix: diff --git a/data-visualization/charts/chart-types.rst b/data-visualization/charts/chart-types.rst index 220f90aa7..fde78b00c 100644 --- a/data-visualization/charts/chart-types.rst +++ b/data-visualization/charts/chart-types.rst @@ -145,9 +145,10 @@ To see a list of entities on which you can sort: #. In the user interface, open the chart. #. Select the :strong:`Chart options` tab. #. Open the :strong:`Sort` dropdown list. In the list, :strong:`Value` is the alias for ``value``, :strong:`Plot name` is the -alias for ``sf_metric``, and :strong:`Metric`` is the alias for ``sf_originatingMetric``. All other list items are dimension names. +alias for ``sf_metric``, and :strong:`Metric` is the alias for ``sf_originatingMetric``. All other list items are dimension names. -:strong:`Examples` +Examples +++++++++++ To sort a list chart by value, specify the following in the request body: From 4d5ddde9f020e3d766a280ac68b4e8400ac9220f Mon Sep 17 00:00:00 2001 From: trangl Date: Thu, 14 Nov 2024 14:30:41 +0100 Subject: [PATCH 03/12] Add line break --- data-visualization/charts/chart-types.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/data-visualization/charts/chart-types.rst b/data-visualization/charts/chart-types.rst index fde78b00c..c6bbd5422 100644 --- a/data-visualization/charts/chart-types.rst +++ b/data-visualization/charts/chart-types.rst @@ -112,7 +112,7 @@ Sorting list charts ------------------- The API lets you sort values in list charts by specifying the ``options.sortBy`` property in the request to create or update a chart. -You can sort on one of the dimensions in the MTS for the chart, a data point, the metric name, or the ``publish()`` method ``label`` argument of the SignalFlow statement that generates the data. To choose one of these options, you specify one of the keyword values shown in the following table: +You can sort on one of the dimensions in the MTS for the chart, a data point, the metric name, or the ``publish()`` method ``label`` argument of the SignalFlow statement that generates the data. To choose one of these options, specify one of the keyword values shown in the following table: .. list-table:: :header-rows: 1 @@ -142,10 +142,12 @@ In addition, you can sort by any dimension of an MTS displayed in the chart. To see a list of entities on which you can sort: -#. In the user interface, open the chart. -#. Select the :strong:`Chart options` tab. -#. Open the :strong:`Sort` dropdown list. In the list, :strong:`Value` is the alias for ``value``, :strong:`Plot name` is the -alias for ``sf_metric``, and :strong:`Metric` is the alias for ``sf_originatingMetric``. All other list items are dimension names. + #. In the user interface, open the chart. + #. Select the :strong:`Chart options` tab. + #. Open the :strong:`Sort` dropdown list. In the list, :strong:`Value` is the alias for ``value``, :strong:`Plot name` is the + alias for ``sf_metric``, and :strong:`Metric` is the alias for ``sf_originatingMetric``. All other list items are dimension names. + + Examples ++++++++++ From 0efff8c8f651dd4b0d062b86f6bd8d52d96849ad Mon Sep 17 00:00:00 2001 From: trangl Date: Thu, 14 Nov 2024 14:34:36 +0100 Subject: [PATCH 04/12] Add line break --- data-visualization/charts/chart-types.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/data-visualization/charts/chart-types.rst b/data-visualization/charts/chart-types.rst index c6bbd5422..e812b494c 100644 --- a/data-visualization/charts/chart-types.rst +++ b/data-visualization/charts/chart-types.rst @@ -142,10 +142,9 @@ In addition, you can sort by any dimension of an MTS displayed in the chart. To see a list of entities on which you can sort: - #. In the user interface, open the chart. - #. Select the :strong:`Chart options` tab. - #. Open the :strong:`Sort` dropdown list. In the list, :strong:`Value` is the alias for ``value``, :strong:`Plot name` is the - alias for ``sf_metric``, and :strong:`Metric` is the alias for ``sf_originatingMetric``. All other list items are dimension names. +#. In the user interface, open the chart. +#. Select the :strong:`Chart options` tab. +#. Open the :strong:`Sort` dropdown list. In the list, :strong:`Value` is the alias for ``value``, :strong:`Plot name` is the alias for ``sf_metric``, and :strong:`Metric` is the alias for ``sf_originatingMetric``. All other list items are dimension names. From ba55c3b52f43ad61acbf17ed2e787f7e278df629 Mon Sep 17 00:00:00 2001 From: trangl Date: Tue, 19 Nov 2024 15:02:24 +0000 Subject: [PATCH 05/12] Remove extra blank lines --- data-visualization/charts/create-charts.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/data-visualization/charts/create-charts.rst b/data-visualization/charts/create-charts.rst index 865fa1042..605464b1d 100644 --- a/data-visualization/charts/create-charts.rst +++ b/data-visualization/charts/create-charts.rst @@ -127,8 +127,6 @@ To learn more about different chart types, see :ref:`chart-types`. The chart type you select is applied as a default to all the plots on the chart, but you can use different visualizations for individual plots. To learn more, see :ref:`plot-config-panel`. - - Edit a chart ============ From 533d0ea72038a137e3aa4f3a1b0d36ee58e5c4c2 Mon Sep 17 00:00:00 2001 From: trangl Date: Tue, 19 Nov 2024 15:27:18 +0000 Subject: [PATCH 06/12] Update some chart types descriptions --- data-visualization/charts/chart-options.rst | 2 +- data-visualization/charts/chart-types.rst | 31 +++++++++------------ 2 files changed, 14 insertions(+), 19 deletions(-) diff --git a/data-visualization/charts/chart-options.rst b/data-visualization/charts/chart-options.rst index a28d4fe66..29eb484a3 100644 --- a/data-visualization/charts/chart-options.rst +++ b/data-visualization/charts/chart-options.rst @@ -109,7 +109,7 @@ In the following illustration, the border on the left indicates that value is or Color theme ============================================================================= -Use this option to specify the color family to use when you populate a histogram chart. To learn more, see :ref:`graph-charts`. The color you select represents the darkest value on the chart; other values are shown with progressively less saturation. +Use this option to specify the color family to use when you populate a histogram chart. To learn more, see :ref:`histogram-charts`. The color you select represents the darkest value on the chart; other values are shown with progressively less saturation. Similar options are available for heatmap charts (see :ref:`color-threshold`) and for single value and list charts. To learn more, see :ref:`color-value`. diff --git a/data-visualization/charts/chart-types.rst b/data-visualization/charts/chart-types.rst index e812b494c..274ca562b 100644 --- a/data-visualization/charts/chart-types.rst +++ b/data-visualization/charts/chart-types.rst @@ -16,15 +16,15 @@ Overview Charts in Splunk Observability Cloud are components of a dashboard. Each chart type provides a different way to represent your data: - :ref:`graph-charts`: Display data points over a period of time. Graph charts come in four different forms. - - :ref:`line-charts`: Display data in a plot with data points connected by a series of straight lines. - - :ref:`area-charts`: Display in a plot similar to a line chart, except that the area below the line is filled. - - :ref:`column-charts`: Also known as bar charts. Display each data point as a vertical bar going from the x-axis origin to the measured value of the data point. The bars aren't connected. - - :ref:`histogram-charts`: Display as horizontal rectangles on a two-dimensional plot. The starting and ending x-position of a rectangle represents the time duration over which data points for that rectangle were collected. The y-position of a rectangle represents the number of data points collected in that time duration. + - :ref:`line-charts`: Display data in a plot with data points connected by a series of straight lines. + - :ref:`area-charts`: Display in a plot similar to a line chart, except that the area below the line is filled. + - :ref:`column-charts`: Also known as bar charts. Display each data point as a vertical bar going from the x-axis origin to the measured value of the data point. The bars aren't connected. + - :ref:`histogram-charts`: Display as horizontal rectangles on a two-dimensional plot. The starting and ending x-position of a rectangle represents the time duration over which data points for that rectangle were collected. The y-position of a rectangle represents the number of data points collected in that time duration. - :ref:`list-charts`: Display multiple data points at each point in time. They show recent trends in the data, including up to 100 data points. - :ref:`single-value-charts`: Display a single value for a data point as it changes over time. In most cases, you use this type of chart to display important metrics as a single number. - :ref:`heatmap-charts`: Display a series of squares each representing a single data point of the selected metric. The color of each square represents the value range of the metric allowing quick identification of values that are higher or lower than desired. - :ref:`event-feed-charts`: Display a list of events instead of metric data. -- :ref:`text-charts`: Text charts let you create a "chart" containing descriptive information. Add this chart to a dashboard to provide an introduction or instructions for other charts in the dashboard. +- :ref:`text-charts`: Display descriptive textual information. Add this chart to a dashboard to provide an introduction or instructions for other charts in the dashboard. - :ref:`table-charts`: Display metrics and dimensions in the table format. To learn more about selecting the appropriate charts in Splunk Observability Cloud, see the following sections for more description and example on each chart type. @@ -38,10 +38,6 @@ Use graph charts when you want to display data points over a period of time. Each metric time series (MTS) in the chart appears as a single plot, and each plot has its own color. For example, a series of line plots for AWS MTS might be colored by their AWS availability zone dimension, with red indicating ``us-east-1``, green indicating ``us-east-2``, and purple indicating ``eu-west-1``. - -Graph chart visualizations ----------------------------- - Graph charts can have one of four forms: - :ref:`line-charts` @@ -54,8 +50,7 @@ Graph charts can have one of four forms: Line charts =========== -The line chart plot type appears as a series of straight lines that -connect the data points in the MTS. +Use line chart when you want to see a series of straight lines that connect the data points in the MTS. .. image:: /_images/data-visualization/charts/line-chart.png :alt: This screenshot shows a line chart illustrating the CPU percentages used for a set of AWS EC2 instances. @@ -66,7 +61,7 @@ connect the data points in the MTS. Area charts =========== -The area chart plot type appears as line chart with the area between the line and the x-axis filled in with the color of the line. +Use area charts when you want to display your data using both lines and shaded areas between the lines and the x-axis. Each line indicates how an MTS changes over time, while each shaded area indicate how each MTS contributes to the overall trend. .. image:: /_images/data-visualization/charts/area-chart.png :alt: This screenshot shows an area chart illustrating the CPU percentages used for a set of AWS EC2 instances. @@ -76,7 +71,7 @@ The area chart plot type appears as line chart with the area between the line an Column charts ============= -The column chart plot type appears as shaded vertical bars starting at the x-axis and ending at the data point value. By default, each plot point is shown as an independent bar. +Use column charts to display your data as shaded vertical bars starting at the x-axis and ending at the data point value. By default, each plot point is shown as an independent bar. You can also stack column charts. The bars representing each value appear as vertical stacks at the corresponding time value along the x-axis. @@ -88,9 +83,9 @@ You can also stack column charts. The bars representing each value appear as ver Histogram charts ================ -Histograms appear as colored rectangular bins indicating how many plot points are at that value. For example, a green bar might indicate a higher density of plot points with the relevant value than a red bar. Alternatively, darker shades of a single color might indicate a higher density of plot points for a value than a lighter shade of that same color. +Use histogram charts to display your data as rectangular bars indicating how many plot points are at that value. For example, a green bar might indicate a higher density of plot points with the relevant value than a red bar. Alternatively, darker shades of a single color might indicate a higher density of plot points for a value than a lighter shade of that same color. -The values of a histogram plot display in a random order by default. You can organize them into two grouping levels to clarify the data. For example, you can group data by AWS region or availability zone to make it easier to track performance within each region or availability zone. +By default, the values of a histogram plot display in a random order. You can organize them into two grouping levels to clarify the data. For example, you can group data by AWS region or availability zone to make it easier to track performance within each region or availability zone. .. image:: /_images/data-visualization/charts/histogram-chart.png :alt: This screenshot shows a histogram chart illustrating CPU percentages used for a set of AWS EC2 instances. @@ -101,7 +96,7 @@ The values of a histogram plot display in a random order by default. You can org List charts =========== -Use this chart type to display current data values in a list format. By default, the name of each value in the chart reflects the name of the plot and any associated analytics. To avoid having the raw metric name displayed on the chart, give the plot a meaningful name. +Use list charts to display current data values in a list format. By default, the name of each value in the chart reflects the name of the plot and any associated analytics. To avoid having the raw metric name displayed on the chart, give the plot a meaningful name. A list chart can display up to 100 items at a time. @@ -212,7 +207,7 @@ Secondary visualizations help you see trends in a list chart: Single value charts =================== -Use this chart type when you want to see a single number in a large font that represents the value of a single data point on a plot line. In most cases, you use this type of chart to display important metrics as a single number. +Use single value charts when you want to see a single number in a large font that represents the value of a single data point on a plot line. In most cases, you use this type of chart to display important metrics as a single number. For example, use single value charts in a summary dashboard shown on a wall TV. The dashboard can display the number of active hosts, active processes, or number of requests served in the past 24 hours. @@ -286,7 +281,7 @@ To help describe the values in the heatmap, add prefix and suffix strings: Event feed charts ================= -Use this chart type when you want to see a list of events on your dashboard. An event feed chart can display one or more event types depending how you specify the criteria. +Use event feed charts when you want to see a list of events on your dashboard. An event feed chart can display one or more event types depending how you specify the criteria. .. image:: /_images/data-visualization/charts/event-feed-chart.png :alt: This screenshot shows an event feed chart illustrating a series of cleared, critical, and custom events. From 20878807483add5f5f430c6cd681cebf20115a66 Mon Sep 17 00:00:00 2001 From: trangl Date: Tue, 19 Nov 2024 15:52:41 +0000 Subject: [PATCH 07/12] Update formatting --- data-visualization/charts/chart-types.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/data-visualization/charts/chart-types.rst b/data-visualization/charts/chart-types.rst index 274ca562b..38b4fcbad 100644 --- a/data-visualization/charts/chart-types.rst +++ b/data-visualization/charts/chart-types.rst @@ -118,7 +118,7 @@ You can sort on one of the dimensions in the MTS for the chart, a data point, th - :strong:`Description` * - ```` - - ```` + - Dimension name - One of the dimensions of the displayed MTS. To see the available dimensions, follow the instructions following this table. * - ``sf_metric`` From f946c8ddda3c19771b283ce6a4ed1882c350a164 Mon Sep 17 00:00:00 2001 From: trangl Date: Tue, 19 Nov 2024 16:24:32 +0000 Subject: [PATCH 08/12] Fix bulleted list indentations --- data-visualization/charts/chart-types.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/data-visualization/charts/chart-types.rst b/data-visualization/charts/chart-types.rst index 38b4fcbad..de883418a 100644 --- a/data-visualization/charts/chart-types.rst +++ b/data-visualization/charts/chart-types.rst @@ -16,10 +16,10 @@ Overview Charts in Splunk Observability Cloud are components of a dashboard. Each chart type provides a different way to represent your data: - :ref:`graph-charts`: Display data points over a period of time. Graph charts come in four different forms. - - :ref:`line-charts`: Display data in a plot with data points connected by a series of straight lines. - - :ref:`area-charts`: Display in a plot similar to a line chart, except that the area below the line is filled. - - :ref:`column-charts`: Also known as bar charts. Display each data point as a vertical bar going from the x-axis origin to the measured value of the data point. The bars aren't connected. - - :ref:`histogram-charts`: Display as horizontal rectangles on a two-dimensional plot. The starting and ending x-position of a rectangle represents the time duration over which data points for that rectangle were collected. The y-position of a rectangle represents the number of data points collected in that time duration. + - :ref:`line-charts`: Display data in a plot with data points connected by a series of straight lines. + - :ref:`area-charts`: Display in a plot similar to a line chart, except that the area below the line is filled. + - :ref:`column-charts`: Also known as bar charts. Display each data point as a vertical bar going from the x-axis origin to the measured value of the data point. The bars aren't connected. + - :ref:`histogram-charts`: Display as horizontal rectangles on a two-dimensional plot. The starting and ending x-position of a rectangle represents the time duration over which data points for that rectangle were collected. The y-position of a rectangle represents the number of data points collected in that time duration. - :ref:`list-charts`: Display multiple data points at each point in time. They show recent trends in the data, including up to 100 data points. - :ref:`single-value-charts`: Display a single value for a data point as it changes over time. In most cases, you use this type of chart to display important metrics as a single number. - :ref:`heatmap-charts`: Display a series of squares each representing a single data point of the selected metric. The color of each square represents the value range of the metric allowing quick identification of values that are higher or lower than desired. From 8496a36a5d1fb17659244ef234e3e22f21907e4a Mon Sep 17 00:00:00 2001 From: trangl Date: Tue, 19 Nov 2024 16:26:18 +0000 Subject: [PATCH 09/12] Fix bold formatting --- data-visualization/charts/chart-types.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/data-visualization/charts/chart-types.rst b/data-visualization/charts/chart-types.rst index de883418a..fca069693 100644 --- a/data-visualization/charts/chart-types.rst +++ b/data-visualization/charts/chart-types.rst @@ -197,10 +197,10 @@ List chart secondary visualization Secondary visualizations help you see trends in a list chart: -- :strong:`Sparkline`: Shows recent trends for each value -- :strong:`Radial`: Shows a dial that marks where the current values are among +- Sparkline: Shows recent trends for each value +- Radial: Shows a dial that marks where the current values are among the expected range of values -- :strong:`Linear`: Shows a bar that marks where the current values are among the expected range of values +- Linear: Shows a bar that marks where the current values are among the expected range of values .. _single-value-charts: @@ -233,10 +233,10 @@ Single value chart secondary visualization Secondary visualizations help you see trends in a single value chart: -- :strong:`Sparkline`: Shows recent trends of the value -- :strong:`Radial`: Shows a dial that marks where the current value is among +- Sparkline: Shows recent trends of the value +- Radial: Shows a dial that marks where the current value is among the expected range of values -- :strong:`Linear`: Shows a bar that marks where the current value is among the expected range of values +- Linear: Shows a bar that marks where the current value is among the expected range of values By default, a single value chart doesn't show any additional visualizations. From f3fce40bf4c1cdce838cfecd3ce01d4cad03a77c Mon Sep 17 00:00:00 2001 From: Anna Urbiztondo Date: Fri, 29 Nov 2024 06:59:39 +0100 Subject: [PATCH 10/12] zero code sweep --- .../automatic-discovery/discovery-windows.rst | 2 +- .../automatic-discovery/k8s/k8s-backend.rst | 34 +++++++++---------- .../linux/linux-backend.rst | 27 +++++++-------- .../windows/windows-backend.rst | 10 +++--- 4 files changed, 35 insertions(+), 38 deletions(-) diff --git a/gdi/opentelemetry/automatic-discovery/discovery-windows.rst b/gdi/opentelemetry/automatic-discovery/discovery-windows.rst index 5259a44ce..2128693b9 100644 --- a/gdi/opentelemetry/automatic-discovery/discovery-windows.rst +++ b/gdi/opentelemetry/automatic-discovery/discovery-windows.rst @@ -18,6 +18,6 @@ Automatic discovery for Windows

Get started

-The Collector for Windows does not support automatic discovery of services. +The Collector for Windows does not support automatic discovery of third-party services. To enable the Collector's zero-code instrumentation of back-end applications written in .NET see :ref:`windows-backend-auto-discovery`. With this option you won't have to install and configure your instrumentation agents separately. \ No newline at end of file diff --git a/gdi/opentelemetry/automatic-discovery/k8s/k8s-backend.rst b/gdi/opentelemetry/automatic-discovery/k8s/k8s-backend.rst index 165fd26f2..347d43e28 100644 --- a/gdi/opentelemetry/automatic-discovery/k8s/k8s-backend.rst +++ b/gdi/opentelemetry/automatic-discovery/k8s/k8s-backend.rst @@ -1,33 +1,33 @@ .. _k8s-backend-auto-discovery: ******************************************************************************** -Automatic instrumentation for back-end applications in Kubernetes +Zero-code instrumentation for back-end applications in Kubernetes ******************************************************************************** .. meta:: - :description: Get started with automatic instrumentation for back-end applications and language runtimes in a Kubernetes environment. + :description: Get started with zero-code instrumentation for back-end applications and language runtimes in a Kubernetes environment. -When using automatic instrumentation, the Splunk Distribution of OpenTelemetry Collector automatically detects back-end applications running in your Kubernetes environment. +When using zero-code instrumentation, the Splunk Distribution of OpenTelemetry Collector automatically detects back-end applications running in your Kubernetes environment. -By deploying the Collector with automatic instrumentation, you can instrument applications and send data to Splunk Observability Cloud without editing your application's code or configuring files. +By deploying the Collector with zero-code instrumentation, you can instrument applications and send data to Splunk Observability Cloud without editing your application's code or configuring files. -Automatic instrumentation for Kubernetes can detect and configure the following applications and language runtimes: +Zero-code instrumentation for Kubernetes can detect and configure the following applications and language runtimes: * Java * .NET * Node.js -How automatic instrumentation for Kubernetes works +How zero-code instrumentation for Kubernetes works ================================================== -Automatic instrumentation for Kubernetes operates as a Kubernetes DaemonSet that you install with Helm. Using Helm, you can specify which language runtimes you want automatic instrumentation to find. After installation, Helm deploys a set of Kubernetes pods in your cluster, which includes the Splunk Distribution of OpenTelemetry Collector, the Kubernetes operator, and other supporting resources. +Zero-code instrumentation for Kubernetes operates as a Kubernetes DaemonSet that you install with Helm. Using Helm, you can specify which language runtimes you want zero-code instrumentation to find. After installation, Helm deploys a set of Kubernetes pods in your cluster, which includes the Splunk Distribution of OpenTelemetry Collector, the Kubernetes operator, and other supporting resources. The Collector and Kubernetes operator listen for requests to your application and gather telemetry data upon detecting activity in your application. The Collector then sends this data to Splunk Application Performance Monitoring (APM). Get started ============================== -To install automatic instrumentation for Kubernetes, complete the following steps: +To install zero-code instrumentation for Kubernetes, complete the following steps: #. :ref:`k8s-auto-discovery-deploy-helm-chart` #. :ref:`k8s-auto-discovery-verify-resources` @@ -39,7 +39,7 @@ To install automatic instrumentation for Kubernetes, complete the following step Requirements =============================================== -You need the following components to use automatic instrumentation for back-end Kubernetes applications: +You need the following components to use zero-code instrumentation for back-end Kubernetes applications: * Helm version 3 or higher. * Administrator access to your Kubernetes cluster and familiarity with your Kubernetes configuration. @@ -297,7 +297,7 @@ The annotation you set depends on the language runtime you're using. You can set - name: my-java-app image: my-java-app:latest - Activate automatic instrumentation by adding ``instrumentation.opentelemetry.io/inject-java: "true"`` to the ``spec``: + Activate zero-code instrumentation by adding ``instrumentation.opentelemetry.io/inject-java: "true"`` to the ``spec``: .. code-block:: yaml :emphasize-lines: 10 @@ -359,7 +359,7 @@ The annotation you set depends on the language runtime you're using. You can set - name: my-dotnet-app image: my-dotnet-app:latest - Activate automatic instrumentation by adding ``instrumentation.opentelemetry.io/otel-dotnet-auto-runtime: "linux-x64"`` and ``instrumentation.opentelemetry.io/inject-dotnet: "monitoring/splunk-otel-collector"`` to the ``spec``: + Activate zero-code instrumentation by adding ``instrumentation.opentelemetry.io/otel-dotnet-auto-runtime: "linux-x64"`` and ``instrumentation.opentelemetry.io/inject-dotnet: "monitoring/splunk-otel-collector"`` to the ``spec``: .. code-block:: yaml :emphasize-lines: 10,11 @@ -398,7 +398,7 @@ The annotation you set depends on the language runtime you're using. You can set - name: my-dotnet-app image: my-dotnet-app:latest - Activate automatic instrumentation by adding ``instrumentation.opentelemetry.io/otel-dotnet-auto-runtime: "linux-musl-x64"`` and ``instrumentation.opentelemetry.io/inject-dotnet: "monitoring/splunk-otel-collector"`` to the ``spec``: + Activate zero-code instrumentation by adding ``instrumentation.opentelemetry.io/otel-dotnet-auto-runtime: "linux-musl-x64"`` and ``instrumentation.opentelemetry.io/inject-dotnet: "monitoring/splunk-otel-collector"`` to the ``spec``: .. code-block:: yaml :emphasize-lines: 10,11 @@ -439,7 +439,7 @@ The annotation you set depends on the language runtime you're using. You can set - name: my-nodejs-app image: my-nodejs-app:latest - Activate automatic instrumentation by adding ``instrumentation.opentelemetry.io/inject-nodejs: "true"`` to the ``spec``: + Activate zero-code instrumentation by adding ``instrumentation.opentelemetry.io/inject-nodejs: "true"`` to the ``spec``: .. code-block:: yaml :emphasize-lines: 10 @@ -475,7 +475,7 @@ Replace ```` with the language of the application you want Instrument applications in multi-container pods ------------------------------------------------- -By default, automatic instrumentation instruments the first container in the Kubernetes pod spec. You can specify multiple containers to instrument by adding an annotation. +By default, zero-code instrumentation instruments the first container in the Kubernetes pod spec. You can specify multiple containers to instrument by adding an annotation. The following example instruments Java applications running in the ``myapp`` and ``myapp2`` containers: @@ -521,10 +521,10 @@ You can also instrument multiple containers with specific languages. To do so, s instrumentation.opentelemetry.io/inject-nodejs: "true" instrumentation.opentelemetry.io/python-container-names: "myapp3" -Deactivate automatic instrumentation +Deactivate zero-code instrumentation ----------------------------------------------- -To deactivate automatic instrumentation, remove the annotation. The following command removes the annotation for automatic instrumentation, deactivating it: +To deactivate zero-code instrumentation, remove the annotation. The following command removes the annotation for zero-code instrumentation, deactivating it: .. code-block:: bash @@ -625,5 +625,5 @@ To troubleshoot common errors that occur when instrumenting applications, see th Learn more =========================================================================== -* To learn more about how automatic instrumentation works in Splunk Observability Cloud, see :new-page:`more detailed documentation in GitHub `. +* To learn more about how zero-code instrumentation works in Splunk Observability Cloud, see :new-page:`more detailed documentation in GitHub `. * See :new-page:`the operator pattern in the Kubernetes documentation ` for more information. diff --git a/gdi/opentelemetry/automatic-discovery/linux/linux-backend.rst b/gdi/opentelemetry/automatic-discovery/linux/linux-backend.rst index db9463889..592377017 100644 --- a/gdi/opentelemetry/automatic-discovery/linux/linux-backend.rst +++ b/gdi/opentelemetry/automatic-discovery/linux/linux-backend.rst @@ -1,33 +1,33 @@ .. _linux-backend-auto-discovery: ***************************************************************************** -Automatic instrumentation for back-end applications in Linux +Zero-code instrumentation for back-end applications in Linux ***************************************************************************** .. meta:: - :description: Get started with automatic instrumentation for back-end applications in Linux environments. + :description: Get started with zero-code instrumentation for back-end applications in Linux environments. -When using automatic instrumentation, the Splunk Distribution of OpenTelemetry Collector automatically detects back-end applications running in your Linux environment. +When using automatic discovery with zero-code instrumentation, the Splunk Distribution of OpenTelemetry Collector automatically detects back-end applications running in your Linux environment. -By deploying the Collector with automatic instrumentation, you can instrument applications and send data to Splunk Observability Cloud without editing your application's code or configuring files. +By deploying the Collector with zero-code instrumentation, you can instrument applications and send data to Splunk Observability Cloud without editing your application's code or configuring files. -Automatic instrumentation for Linux can detect and configure the following applications and language runtimes: +Zero-code instrumentation for Linux can detect and configure the following applications and language runtimes: * Java * Node.js * .NET -How automatic instrumentation for Linux works +How zero-code instrumentation for Linux works =================================================== -Automatic instrumentation for Linux operates as a mode of the Splunk Distribution of OpenTelemetry Collector. You install and activate automatic instrumentation for the Collector by using the Linux installer script or package manager. During installation, you can specify the types of language runtimes you want the Collector to detect. +Zero-code instrumentation for Linux operates as a mode of the Splunk Distribution of OpenTelemetry Collector. You install and activate zero-code instrumentation for the Collector by using the Linux installer script or package manager. During installation, you can specify the types of language runtimes you want the Collector to detect. After installation, the Collector runs in your Linux environment and listens for requests to your applications. When the Collector detects activity, it gathers telemetry data from your application runtime and sends this data to Splunk Application Performance Monitoring (APM). Requirements ================================================== -You need the following components to use automatic instrumentation for back-end Linux applications: +You need the following components to use zero-code instrumentation for back-end Linux applications: * ``systemd`` * ``curl`` @@ -54,7 +54,7 @@ Make sure you've also installed the components specific to your language runtime Get started =============================== -To install and use automatic instrumentation for Linux, follow these steps: +To install and use zero-code instrumentation for Linux, follow these steps: #. :ref:`auto-discovery-linux-install` #. :ref:`auto-discovery-linux-verify` @@ -65,7 +65,7 @@ To install and use automatic instrumentation for Linux, follow these steps: Install the package ======================================= -Using the installer script, you can install and activate automatic instrumentation for either all supported applications on the host via the system-wide method or only for applications running as ``systemd`` services. +Using the installer script, you can install and activate zero-code instrumentation for either all supported applications on the host via the system-wide method or only for applications running as ``systemd`` services. .. tabs:: @@ -415,7 +415,7 @@ If the service fails to start, check that the ``SPLUNK_REALM`` and ``SPLUNK_ACCE Start your applications ------------------------------------------------ -For automatic instrumentation to take effect, you must either restart the host or manually start or restart any applications on the host where you installed the package. You must restart the host or applications after installing the automatic instrumentation package for the first time and whenever you make any changes to the configuration file. +For zero-code instrumentation to take effect, you must either restart the host or manually start or restart any applications on the host where you installed the package. You must restart the host or applications after installing the automatic instrumentation package for the first time and whenever you make any changes to the configuration file. After your applications are running, you can verify your data. See :ref:`auto-discovery-view-results-linux`. You can also configure instrumentation settings. See :ref:`auto-discovery-configure-linux`. @@ -433,10 +433,9 @@ To learn more, see the following resources: .. _auto-discovery-upgrade-package: -Update automatic instrumentation +Update zero-code instrumentation ================================================== - .. tabs:: .. tab:: Java @@ -683,5 +682,5 @@ To troubleshoot common errors that occur when instrumenting applications, see th View results in Splunk APM ==================================================== -After activating automatic instrumentation, ensure your data is flowing into Splunk Observability Cloud. See :ref:`verify-apm-data`. +After activating zero-code instrumentation, ensure your data is flowing into Splunk Observability Cloud. See :ref:`verify-apm-data`. \ No newline at end of file diff --git a/gdi/opentelemetry/automatic-discovery/windows/windows-backend.rst b/gdi/opentelemetry/automatic-discovery/windows/windows-backend.rst index 3246fbc2b..9dc0919a6 100644 --- a/gdi/opentelemetry/automatic-discovery/windows/windows-backend.rst +++ b/gdi/opentelemetry/automatic-discovery/windows/windows-backend.rst @@ -1,20 +1,20 @@ .. _windows-backend-auto-discovery: **************************************************************** -Automatic instrumentation for back-end applications in Windows +Zero-code instrumentation for back-end applications in Windows **************************************************************** .. meta:: :description: draft -Automatic discovery and instrumentation for OpenTelemetry .NET activates zero-code instrumentation for .NET applications running on Windows. By default, zero-code instrumentation is only turned on for IIS applications. To activate other application and service types, see :ref:`otel-dotnet-manual-install`. After installing the package, you must start or restart any .NET applications that you want to instrument. +Automatic discovery for OpenTelemetry .NET activates zero-code instrumentation for .NET applications running on Windows. By default, zero-code instrumentation is only turned on for IIS applications. To activate other application and service types, see :ref:`otel-dotnet-manual-install`. After installing the package, you must start or restart any .NET applications that you want to instrument. .. note:: The SignalFx instrumentation for .NET is deprecated and will reach end of support on February 21, 2025. To learn how to migrate from SignalFx .NET to OpenTelemetry .NET, see :ref:`migrate-signalfx-dotnet-to-dotnet-otel`. Get started ================================================== -To get started with automatic instrumentation for Windows, follow these steps: +To get started with zero-code instrumentation for Windows, follow these steps: #. :ref:`windows-install-package` #. :ref:`configure-the-package-dotnet` @@ -43,14 +43,12 @@ Do the following to customize the command: - Replace ```` with a valid Splunk Observability Cloud access token. To obtain an access token, see :ref:`admin-api-access-tokens`. - Replace ```` is the Splunk Observability Cloud realm, for example, ``us0``. To find the realm name of your account, open the navigation menu in Splunk Observability Cloud, select :menuselection:`Settings`, and then select your username. The realm name appears in the :guilabel:`Organizations` section. - - .. _configure-the-package-dotnet: Configure the .NET instrumentation ========================================================== -To configure the instrumentation, see :ref:`advanced-dotnet-otel-configuration`. +To configure .NET instrumentation, see :ref:`advanced-dotnet-otel-configuration`. .. _upgrade-the-package-dotnet: From 8c1c2e529c40d592df75e06c9cdd7f1ebe8b720f Mon Sep 17 00:00:00 2001 From: Anna Urbiztondo Date: Fri, 29 Nov 2024 12:49:20 +0100 Subject: [PATCH 11/12] Fixes --- .../discovery-kubernetes.rst | 4 +-- .../automatic-discovery/discovery-linux.rst | 2 +- .../automatic-discovery/discovery-windows.rst | 2 +- .../automatic-discovery/k8s/k8s-backend.rst | 8 ++--- .../linux/linux-backend.rst | 32 +++++++++---------- 5 files changed, 22 insertions(+), 26 deletions(-) diff --git a/gdi/opentelemetry/automatic-discovery/discovery-kubernetes.rst b/gdi/opentelemetry/automatic-discovery/discovery-kubernetes.rst index f77c05c3f..8b94ec6a9 100644 --- a/gdi/opentelemetry/automatic-discovery/discovery-kubernetes.rst +++ b/gdi/opentelemetry/automatic-discovery/discovery-kubernetes.rst @@ -5,7 +5,7 @@ Automatic discovery for Kubernetes ************************************************************************ .. meta:: - :description: Get started with automatic discovery and instrumentation for Kubernetes environments. Deploy automatic discovery and instrumentation to automatically find services and applications running in your environment and send data from them to Splunk Observability Cloud. + :description: Get started with automatic discovery and zero-code instrumentation for Kubernetes environments. Deploy automatic discovery and zero-code instrumentation to automatically find services and applications running in your environment and send data from them to Splunk Observability Cloud. .. toctree:: :hidden: @@ -25,4 +25,4 @@ To enable the Collector's zero-code instrumentation of back-end applications wri To use the Collector's automatic discovery of third-party applications in Kubernetes environments see :ref:`k8s-third-party`. With this option you'll only have to reuse a config file automatically generated by the Collector. -For a walkthrough of how to use automatic instrumentation to instrument an application in a Kubernetes environment, see :ref:`k8s-advanced-auto-discovery-config`. \ No newline at end of file +For a walkthrough of how to use automatic discovery and zero-code instrumentation to monitor an application in a Kubernetes environment, see :ref:`k8s-advanced-auto-discovery-config`. \ No newline at end of file diff --git a/gdi/opentelemetry/automatic-discovery/discovery-linux.rst b/gdi/opentelemetry/automatic-discovery/discovery-linux.rst index 5d49dfa59..f48e9ed3d 100644 --- a/gdi/opentelemetry/automatic-discovery/discovery-linux.rst +++ b/gdi/opentelemetry/automatic-discovery/discovery-linux.rst @@ -5,7 +5,7 @@ Automatic discovery for Linux ************************************************************************ .. meta:: - :description: Get started with automatic discovery and instrumentation for Linux environments. Deploy automatic discovery and instrumentation to automatically find services and applications running in your Linux environment and send data from them to Splunk Observability Cloud. + :description: Get started with automatic discovery and zero-code instrumentation for Linux environments. Deploy automatic discovery and zero-code instrumentation to automatically find services and applications running in your Linux environment and send data from them to Splunk Observability Cloud. .. toctree:: :hidden: diff --git a/gdi/opentelemetry/automatic-discovery/discovery-windows.rst b/gdi/opentelemetry/automatic-discovery/discovery-windows.rst index 2128693b9..92df4f8b6 100644 --- a/gdi/opentelemetry/automatic-discovery/discovery-windows.rst +++ b/gdi/opentelemetry/automatic-discovery/discovery-windows.rst @@ -5,7 +5,7 @@ Automatic discovery for Windows ************************************************************************ .. meta:: - :description: Get started with automatic instrumentation for Windows environments. Deploy automatic instrumentation to automatically find applications running in your Windows environment and send data from them to Splunk Observability Cloud. + :description: Get started with automatic discovery for Windows environments. Deploy zero-code instrumentation to automatically find applications running in your Windows environment and send data from them to Splunk Observability Cloud. .. toctree:: :hidden: diff --git a/gdi/opentelemetry/automatic-discovery/k8s/k8s-backend.rst b/gdi/opentelemetry/automatic-discovery/k8s/k8s-backend.rst index 347d43e28..053e47e35 100644 --- a/gdi/opentelemetry/automatic-discovery/k8s/k8s-backend.rst +++ b/gdi/opentelemetry/automatic-discovery/k8s/k8s-backend.rst @@ -7,9 +7,7 @@ Zero-code instrumentation for back-end applications in Kubernetes .. meta:: :description: Get started with zero-code instrumentation for back-end applications and language runtimes in a Kubernetes environment. -When using zero-code instrumentation, the Splunk Distribution of OpenTelemetry Collector automatically detects back-end applications running in your Kubernetes environment. - -By deploying the Collector with zero-code instrumentation, you can instrument applications and send data to Splunk Observability Cloud without editing your application's code or configuring files. +The Splunk Distribution of the OpenTelemetry Collector uses automatic discovery with zero-code instrumentation to automatically detect back-end applications running in your Kubernetes environment. By deploying the Collector with zero-code instrumentation, you can instrument applications and send data to Splunk Observability Cloud without editing your application's code or configuring files. Zero-code instrumentation for Kubernetes can detect and configure the following applications and language runtimes: @@ -524,7 +522,7 @@ You can also instrument multiple containers with specific languages. To do so, s Deactivate zero-code instrumentation ----------------------------------------------- -To deactivate zero-code instrumentation, remove the annotation. The following command removes the annotation for zero-code instrumentation, deactivating it: +To deactivate zero-code instrumentation remove the annotation using the following command: .. code-block:: bash @@ -616,7 +614,7 @@ See :ref:`k8s-advanced-auto-discovery-config` for more information. .. include:: /_includes/gdi/troubleshoot-zeroconfig-k8s.rst -To troubleshoot common errors that occur when instrumenting applications, see the following troubleshooting guides: +To troubleshoot common errors that occur when instrumenting applications, see the following guides: * Java: :ref:`common-java-troubleshooting` * Node.js: :ref:`common-nodejs-troubleshooting` diff --git a/gdi/opentelemetry/automatic-discovery/linux/linux-backend.rst b/gdi/opentelemetry/automatic-discovery/linux/linux-backend.rst index 592377017..a6192a3e7 100644 --- a/gdi/opentelemetry/automatic-discovery/linux/linux-backend.rst +++ b/gdi/opentelemetry/automatic-discovery/linux/linux-backend.rst @@ -7,9 +7,7 @@ Zero-code instrumentation for back-end applications in Linux .. meta:: :description: Get started with zero-code instrumentation for back-end applications in Linux environments. -When using automatic discovery with zero-code instrumentation, the Splunk Distribution of OpenTelemetry Collector automatically detects back-end applications running in your Linux environment. - -By deploying the Collector with zero-code instrumentation, you can instrument applications and send data to Splunk Observability Cloud without editing your application's code or configuring files. +The Splunk Distribution of the OpenTelemetry Collector uses automatic discovery with zero-code instrumentation to automatically detect back-end applications running in your Linux environment. By deploying the Collector with zero-code instrumentation, you can monitor applications and send data to Splunk Observability Cloud without editing your application's code or configuring files. Zero-code instrumentation for Linux can detect and configure the following applications and language runtimes: @@ -20,7 +18,7 @@ Zero-code instrumentation for Linux can detect and configure the following appli How zero-code instrumentation for Linux works =================================================== -Zero-code instrumentation for Linux operates as a mode of the Splunk Distribution of OpenTelemetry Collector. You install and activate zero-code instrumentation for the Collector by using the Linux installer script or package manager. During installation, you can specify the types of language runtimes you want the Collector to detect. +Zero-code instrumentation for Linux operates as a mode of the Splunk Distribution of the OpenTelemetry Collector. You install and activate zero-code instrumentation for the Collector by using the Linux installer script or package manager. During installation, you can specify the types of language runtimes you want the Collector to detect. After installation, the Collector runs in your Linux environment and listens for requests to your applications. When the Collector detects activity, it gathers telemetry data from your application runtime and sends this data to Splunk Application Performance Monitoring (APM). @@ -49,7 +47,7 @@ Make sure you've also installed the components specific to your language runtime .NET version 6.0 or higher and supported libraries. See :ref:`dotnet-otel-requirements` for more information. - Automatic instrumentation for .NET is only supported for x86_64/AMD64 architectures. + Zero-code instrumentation for .NET is only supported for x86_64/AMD64 architectures. Get started =============================== @@ -76,9 +74,9 @@ Using the installer script, you can install and activate zero-code instrumentati .. tab:: Installer script - Using the installer script, you can install the automatic instrumentation package for Java and activate automatic instrumentation for Java for either all supported Java applications on the host via the system-wide method or for only Java applications running as ``systemd`` services. + Using the installer script, you can install the zero-code instrumentation package for Java and activate zero-code instrumentation for Java for either all supported Java applications on the host via the system-wide method or for only Java applications running as ``systemd`` services. - .. note:: By default, automatic instrumentation is activated for all languages (Java, Node.js, and .NET) when using the installer script. To deactivate automatic instrumentation for other languages, add the ``--without-instrumentation-sdk [language]`` option in the installer script command. + .. note:: By default, zero-code instrumentation is activated for all languages (Java, Node.js, and .NET) when using the installer script. To deactivate zero-code instrumentation for other languages, add the ``--without-instrumentation-sdk [language]`` option in the installer script command. .. tabs:: @@ -93,7 +91,7 @@ Using the installer script, you can install and activate zero-code instrumentati .. note:: If you wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option. - The system-wide automatic instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/java.conf``. + The system-wide zero-code instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/java.conf``. To automatically define the optional ``deployment.environment`` resource attribute at installation time, run the installer script with the ``--deployment-environment `` option. Replace ```` with the desired attribute value, for example, ``prod``, as shown in the following example: @@ -209,7 +207,7 @@ Using the installer script, you can install and activate zero-code instrumentati .. tab:: Installer script - Using the installer script, you can install and activate automatic instrumentation for Node.js for either all supported Node.js applications on the host via the system-wide method or for only Node.js applications running as ``systemd`` services. + Using the installer script, you can install and activate zero-code instrumentation for Node.js for either all supported Node.js applications on the host via the system-wide method or for only Node.js applications running as ``systemd`` services. The installer script installs the Node.js package using the ``npm install`` command. To specify a custom path to ``npm`` for installation, use the ``--npm-path `` option as in the following example: @@ -217,7 +215,7 @@ Using the installer script, you can install and activate zero-code instrumentati --npm-path /custom/path/to/npm - .. note:: By default, automatic instrumentation is activated for all languages (Java, Node.js, and .NET) when using the installer script. To deactivate automatic instrumentation for other languages, add the ``--without-instrumentation-sdk [language]`` option in the installer script command. + .. note:: By default, zero-code instrumentation is activated for all languages (Java, Node.js, and .NET) when using the installer script. To deactivate zero-code instrumentation for other languages, add the ``--without-instrumentation-sdk [language]`` option in the installer script command. .. tabs:: @@ -234,7 +232,7 @@ Using the installer script, you can install and activate zero-code instrumentati .. note:: If you wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option. - The system-wide automatic instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/node.conf``. + The system-wide zero-code instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/node.conf``. You can activate AlwaysOn Profiling for CPU and memory, as well as metrics, using additional options, as in the following example: @@ -257,7 +255,7 @@ Using the installer script, you can install and activate zero-code instrumentati curl -sSL https://dl.signalfx.com/splunk-otel-collector.sh > /tmp/splunk-otel-collector.sh && \ sudo sh /tmp/splunk-otel-collector.sh --with-systemd-instrumentation --realm -- - The ``systemd`` automatic instrumentation method automatically adds environment variables to ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf``. + The ``systemd`` zero-code instrumentation method automatically adds environment variables to ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf``. .. note:: If you wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option. @@ -296,9 +294,9 @@ Using the installer script, you can install and activate zero-code instrumentati .. tab:: Installer script - Using the installer script, you can install and activate automatic instrumentation for .NET for either all supported .NET applications on the host via the system-wide method or for only .NET applications running as ``systemd`` services. + Using the installer script, you can install and activate zero-code instrumentation for .NET for either all supported .NET applications on the host via the system-wide method or for only .NET applications running as ``systemd`` services. - .. note:: By default, automatic instrumentation is activated for all languages (Java, Node.js, and .NET) when using the installer script. To deactivate automatic instrumentation for other languages, add the ``--without-instrumentation-sdk [language]`` option in the installer script command. + .. note:: By default, zero-code instrumentation is activated for all languages (Java, Node.js, and .NET) when using the installer script. To deactivate zero-code instrumentation for other languages, add the ``--without-instrumentation-sdk [language]`` option in the installer script command. .. tabs:: @@ -313,7 +311,7 @@ Using the installer script, you can install and activate zero-code instrumentati .. note:: If you wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance by specifying the ``--with-fluentd`` option. - The system-wide automatic instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/dotnet.conf``. + The system-wide zero-code instrumentation method automatically adds environment variables to ``/etc/splunk/zeroconfig/dotnet.conf``. To automatically define the optional ``deployment.environment`` resource attribute at installation time, run the installer script with the ``--deployment-environment `` option. Replace ```` with the desired attribute value, for example, ``prod``, as shown in the following example: @@ -415,7 +413,7 @@ If the service fails to start, check that the ``SPLUNK_REALM`` and ``SPLUNK_ACCE Start your applications ------------------------------------------------ -For zero-code instrumentation to take effect, you must either restart the host or manually start or restart any applications on the host where you installed the package. You must restart the host or applications after installing the automatic instrumentation package for the first time and whenever you make any changes to the configuration file. +For zero-code instrumentation to take effect, you must either restart the host or manually start or restart any applications on the host where you installed the package. You must restart the host or applications after installing the zero-code instrumentation package for the first time and whenever you make any changes to the configuration file. After your applications are running, you can verify your data. See :ref:`auto-discovery-view-results-linux`. You can also configure instrumentation settings. See :ref:`auto-discovery-configure-linux`. @@ -588,7 +586,7 @@ Update zero-code instrumentation sudo npm install /usr/lib/splunk-instrumentation/splunk-otel-js.tgz - The default automatic instrumentation configuration expects the Node.js agent to be installed under the ``/usr/lib/splunk-instrumentation/splunk-otel-js`` path. + The default zero-code instrumentation configuration expects the Node.js agent to be installed under the ``/usr/lib/splunk-instrumentation/splunk-otel-js`` path. If the Node.js agent is installed under a different path, manually update the path for the ``NODE_OPTIONS`` environment variable in either ``/etc/splunk/zeroconfig/node.conf`` for system-wide services or ``/usr/lib/systemd/system.conf.d/00-splunk-otel-auto-instrumentation.conf`` for ``systemd`` services. For example: From 7caba6e5f247224ae181c5e679aabd47af237dc3 Mon Sep 17 00:00:00 2001 From: Anna Urbiztondo Date: Fri, 29 Nov 2024 12:52:08 +0100 Subject: [PATCH 12/12] fix --- gdi/opentelemetry/collector-linux/install-linux.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gdi/opentelemetry/collector-linux/install-linux.rst b/gdi/opentelemetry/collector-linux/install-linux.rst index 324938427..30c3403a3 100644 --- a/gdi/opentelemetry/collector-linux/install-linux.rst +++ b/gdi/opentelemetry/collector-linux/install-linux.rst @@ -143,7 +143,7 @@ To use host bindings, run this command: Options of the installer script of the Collector for Linux ================================================================== -The Linux installer script supports the following options for the Collector, automatic discovery for back-end services and Fluentd. +The Linux installer script supports the following options for the Collector, automatic discovery with zero-code instrumentation for back-end services, and Fluentd. To display all the configuration options supported by the script, use the ``-h`` flag.