diff --git a/apm/apm-spans-traces/span-formats.rst b/apm/apm-spans-traces/span-formats.rst index 8fa3bbafd..67a02a06d 100644 --- a/apm/apm-spans-traces/span-formats.rst +++ b/apm/apm-spans-traces/span-formats.rst @@ -98,19 +98,4 @@ For more information on the ingest API endpoints, see :new-page:`Send APM traces .. note:: You can also send trace data in OTLP format directly to Splunk Observability Cloud using the gRPC endpoint, either directly or from an OpenTelemetry Collector. See :ref:`grpc-data-ingest`. -.. _apm-formats-smart-agent: -Span formats compatible with the Smart Agent (deprecated) -============================================================ - -The Smart Agent can receive the following span formats with the ``signalfx-forwarder`` monitor: - -- Jaeger: gRPC and Thrift -- Zipkin v1, v2 JSON - -The Smart Agent can export the following span formats using the ``writer`` exporter: - -- Zipkin v1, v2 JSON -- SAPM - -To configure the Smart Agent for Splunk APM, see :ref:`smart-agent`. diff --git a/gdi/monitors-databases/postgresql.rst b/gdi/monitors-databases/postgresql.rst index c07d5806a..e52bdbf4a 100644 --- a/gdi/monitors-databases/postgresql.rst +++ b/gdi/monitors-databases/postgresql.rst @@ -73,8 +73,7 @@ The following table shows the configuration options for the - no - ``list of strings`` - List of databases to send database-specific metrics about. If - omitted, metrics about all databases will be sent. This is an - :ref:`overridable set ` + omitted, metrics about all databases will be sent. (**default:** ``[*]``) - diff --git a/gdi/monitors-hosts/filesystems.rst b/gdi/monitors-hosts/filesystems.rst index 6367c9d1e..199fc7832 100644 --- a/gdi/monitors-hosts/filesystems.rst +++ b/gdi/monitors-hosts/filesystems.rst @@ -105,8 +105,7 @@ The following table shows the configuration options for this monitor. - ``fsTypes`` - no - ``list of strings`` - - The filesystem types to include. This is an - :ref:`overridable set ` If this is + - The filesystem types to include. If this is not set, the default value is the set of all **non-logical/virtual filesystems** on the system. On Linux this list is determined by reading the ``/proc/filesystems`` @@ -117,8 +116,7 @@ The following table shows the configuration options for this monitor. - ``mountPoints`` - no - ``list of strings`` - - The mount paths to include/exclude. This is an - :ref:`overridable set ` **Note**: + - The mount paths to include/exclude. **Note**: If you are using the hostFSPath option, do not include the ``/hostfs/`` mount in the filter. If both this and ``fsTypes`` are specified, the two filters combine in an AND relationship. diff --git a/gdi/monitors-network/net-io.rst b/gdi/monitors-network/net-io.rst index 6200c42b7..3a77c2d87 100644 --- a/gdi/monitors-network/net-io.rst +++ b/gdi/monitors-network/net-io.rst @@ -68,8 +68,7 @@ integration: - ``interfaces`` - no - ``list of strings`` - - The network interfaces to send metrics about. This is an - :ref:`overridable set ` + - The network interfaces to send metrics about. (**default:** ``[* !/^lo\d*$/ !/^docker.*/ !/^t(un|ap)\d*$/ !/^veth.*$/ !/^Loopback*/]``) diff --git a/gdi/smart-agent/smart-agent-commands.rst b/gdi/smart-agent/smart-agent-commands.rst deleted file mode 100644 index c3f4fea44..000000000 --- a/gdi/smart-agent/smart-agent-commands.rst +++ /dev/null @@ -1,611 +0,0 @@ -.. _smart-agent-commands: - -******************************************************************************************** -SignalFx Smart Agent commands reference -******************************************************************************************** - -.. meta:: - :description: The most commonly used commands for the SignalFx Smart Agent. - -This topic provides commonly used commands for the Smart Agent. - -.. note:: The SignalFx Smart Agent has reached End of Support. While the agent can capture and export telemetry to Splunk Observability Cloud, Splunk no longer provides any support, feature updates, security, or bug fixes. Such requests are not bound by any SLAs. - - To see commonly used commands for the Splunk Distribution of OpenTelemetry Collector, see :ref:`otel-commands`. - -The standard ports for the Smart Agent are 9080 and 8095. The default configuration is stored in /etc/signalfx/agent.yaml. - -.. note:: - When you deploy the agent as a DaemonSet on Kubernetes clusters, the agent configuration is managed by the ConfigMap of the agent. - -The following table lists all the commands and their usage in context of the Smart Agent. Click a command for a more detailed description and syntax examples. - -.. list-table:: - :header-rows: 1 - :widths: 20 80 - - * - Command - - Usage - * - :ref:`sa-delete` - - Delete the Smart Agent Helm chart repository - * - :ref:`sa-install` - - Deploy the Smart Agent Helm chart repository - * - :ref:`sa-add` - - Add the Smart Agent Helm chart repository - * - :ref:`sa-update` - - Update the Smart Agent Helm chart repository - * - :ref:`sa-journalctl` - - Check the agent logs on the host - * - :ref:`sa-k8s-config` - - Modify Kubernetes configurations - * - :ref:`sa-k8s-create` - - Create a Kubernetes resource - * - :ref:`sa-k8s-delete` - - Delete a Kubernetes resource - * - :ref:`sa-k8s-describe` - - Check Kubernetes system configurations - * - :ref:`sa-k8s-edit` - - Edit a Kubernetes resource - * - :ref:`sa-k8s-exec` - - Execute a command in a Kubernetes container - * - :ref:`sa-k8s-get` - - Display one or many resources running on Kubernetes - * - :ref:`sa-k8s-logs` - - Check logs in a Kubernetes container - * - :ref:`sa-restart` - - Restart the agent on the host - * - :ref:`sa-start` - - Start the agent on the host - * - :ref:`sa-status` - - Check the status of the agent on the host - * - :ref:`sa-status-endpoints` - - Check the endpoints set on the agent - * - :ref:`sa-stop` - - Stop the agent on the host - * - :ref:`sa-tap-dps` - - Tail metric data points being sent to the host - -.. _sa-delete: - -helm delete -======================================================== -Description ------------------ - -Delete the Smart Agent Helm chart repository. - -Syntax ------------------ - -.. code-block:: bash - - helm delete signalfx-agent - -.. _sa-install: - -helm install -======================================================== -Description ------------------ - -Deploy the Smart Agent Helm chart repository. - -Syntax ------------------ - -.. code-block:: bash - - helm install \ - --set signalFxAccessToken=$ACCESS_TOKEN \ - --set clusterName= \ - --set kubeletAPI.url=https://localhost:10250 \ - --set signalFxRealm=$REALM \ - --set traceEndpointUrl=https://ingest.$REALM.signalfx.com/v2/trace \ - --set gatherDockerMetrics=false \ - signalfx-agent signalfx/signalfx-agent \ - -f ~/workshop/k3s/values.yaml - -.. _sa-add: - -helm repo add -======================================================== -Description ------------------ - -Add the Smart Agent Helm chart repository. - -Syntax ------------------ - -.. code-block:: bash - - helm repo add signalfx https://dl.signalfx.com/helm-repo - - # Use these two commands together to add and update the repository at the same time - helm repo add signalfx https://dl.signalfx.com/helm-repo && helm repo update - -.. _sa-update: - -helm repo update -======================================================== -Description ------------------ - -Update the Smart Agent Helm chart repository. - -Syntax ------------------ - -.. code-block:: bash - - helm repo update https://dl.signalfx.com/helm-repo - -.. _sa-journalctl: - -journalctl -======================================================== -Description ------------------ - -Check the agent logs on the host. - -Syntax ------------------ - -.. code-block:: bash - - journalctl -u signalfx-agent | tail -f - tail -f /var/log/signalfx-agent.log - -Optional arguments -^^^^^^^^^^^^^^^^^^^^^^^ - -.. list-table:: - :widths: 30 70 - :header-rows: 1 - - * - Argument - - Description - * - ``-u`` - - Show messages for the specified systemd unit UNIT (such as a service unit), or for any of the units matched by PATTERN - * - ``tail -f`` - - Display the last part of a file. The ``-f`` option causes tail to not stop when end of file is reached, but rather to wait for additional data to be appended to the input. The ``-f`` option is ignored if the standard input is a pipe, but not if it is a FIFO. - -.. _sa-k8s-config: - -kubectl config -============================================ -Description ---------------- - -Modify Kubernetes configurations using subcommands. See the Kubectl Reference Documentation for a full list of subcommands and optional arguments. - -Syntax ---------------- - -.. code-block:: bash - - kubectl config [subcommand] - - # Examples - - # Show kubeconfig settings - kubectl config view - - # Save namespace for all subsequent kubectl commands in context - kubectl config set-context --current --namespace=ggckad-s2 - - # Get the password for the e2e user - kubectl config view -o jsonpath='{.users[?(@.name == "e2e")].user.password}' - - # Display the first user - kubectl config view -o jsonpath='{.users[].name}' - - # Get a list of users - kubectl config view -o jsonpath='{.users[*].name}' - - # Display list of contexts - kubectl config get-contexts - - # Display the current-context - kubectl config current-context - - # Set the default context to my-cluster-name - kubectl config use-context my-cluster-name - - # Add a new user to your kubeconfig that supports basic authorization - kubectl config set-credentials kubeuser/foo.kubernetes.com --username=kubeuser --password=kubepassword - - # Set a context utilizing a specific username and namespace - kubectl config set-context gce --user=cluster-admin --namespace=foo \ && kubectl config use-context gce - -.. _sa-k8s-create: - -kubectl create -======================================================== -Description ------------- - -Create a resource from a file. Accepted file formats are JSON and YAML. See the Kubectl Reference Documentation for a full list of subcommands and optional arguments. - -Syntax ------------- - -.. code-block:: bash - - sudo kubectl create -f - - # Examples - - # Use the subcommand configmap to create a ConfigMap from a source file - sudo kubectl create configmap --from-file= - -Optional arguments -^^^^^^^^^^^^^^^^^^^^^^ - -.. list-table:: - :widths: 30 70 - :header-rows: 1 - - * - Argument - - Description - * - ``-f`` - - The source file to create a resource - * - ``--from-file`` - - Path to the source file to create a ConfigMap - * - ```` - - Name of the ConfigMap - -.. _sa-k8s-delete: - -kubectl delete -============================================ -Description ------------------ - -Delete a resource from a source file. See the Kubectl Reference Documentation for a full list of subcommands and optional arguments. - -Syntax -------------------- - -.. code-block:: bash - - sudo kubectl delete -f - -Optional arguments -^^^^^^^^^^^^^^^^^^^^^^^^^ - -.. list-table:: - :widths: 30 70 - :header-rows: 1 - - * - Argument - - Description - * - ``-f`` - - The source file to delete a resource - -.. _sa-k8s-describe: - -kubectl describe -======================================================== -Description -------------------- - -Check Kubernetes system configurations. - -Syntax -------------------- - -.. code-block:: bash - - kubectl describe -n pod - -Optional arguments -^^^^^^^^^^^^^^^^^^^^^ - -.. list-table:: - :widths: 30 70 - :header-rows: 1 - - * - Argument - - Description - * - ``-n`` - - Namespace to check the configurations - * - ``pod`` - - Pod to check the configurations - -.. _sa-k8s-edit: - -kubectl edit -======================================================== -Description --------------- - -Edit a resource running on a Kubernetes container. - -Syntax ---------------- - -.. code-block:: bash - - kubectl edit cm - kubectl edit ds - - -Optional arguments -^^^^^^^^^^^^^^^^^^^^^ - -.. list-table:: - :widths: 30 70 - :header-rows: 1 - - * - Argument - - Description - * - ``cm`` - - Specify the item you want to modify is a ConfigMap - * - ``ds`` - - Specify the item you want to modify is a DaemonSet - * - ```` - - Name of the resource you want to modify - -.. _sa-k8s-exec: - -kubectl exec -======================================================== -Description -------------- - -Execute a command in a Kubernetes container. - -Syntax -------------- - -.. code-block:: bash - - kubectl exec -- signalfx-agent status - -Optional arguments -^^^^^^^^^^^^^^^^^^^^^^^ - -.. list-table:: - :widths: 30 70 - :header-rows: 1 - - * - Argument - - Description - * - ```` - - Name of the pod - * - ``-- signalfx-agent status`` - - Check the status of the agent - -.. _sa-k8s-get: - -kubectl get -======================================================== -Description ----------------- - -Display one or many resources running on Kubernetes. - -Syntax ----------------- - -.. code-block:: bash - - kubectl get pods -n - kubectl get configmap - kubectl get ds - -Optional arguments -^^^^^^^^^^^^^^^^^^^^^ - -.. list-table:: - :widths: 30 70 - :header-rows: 1 - - * - Argument - - Description - * - ``configmap`` - - Display the ConfigMap - * - ``ds`` - - Display the DaemonSet - * - ``-n`` - - Namespace - * - ``pods`` - - List all pods in process status output format - -.. _sa-k8s-logs: - -kubectl logs -============================================ -Description -------------------- - -Check logs in a Kubernetes container. - -Syntax --------------------- - -.. code-block:: bash - - sudo kubectl logs -l