[systemd] remove systemd instructions (#130)

* [systemd] remove systemd instructions

* remove examples from package

Author: atoulme

.chloggen/remove_systemd.yaml

@@ -0,0 +1,28 @@
+# Use this changelog template to create an entry for release notes.
+
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: breaking
+
+# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
+component: systemd
+
+# A brief description of the change.  Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Remove systemd instructions
+
+# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
+issues: [68]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext: |
+  We can remove systemD instructions as the LD_PRELOAD solution works just as well and applies to any software.
+
+# If your change doesn't affect end users or the exported elements of any package,
+# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
+# Optional: The change log or logs in which this entry should be included.
+# e.g. '[user]' or '[user, api]'
+# Include 'user' if the change is relevant to end users.
+# Include 'api' if there is a change to a library API.
+# Default: '[user]'
+change_logs: []

README.md

@@ -31,15 +31,7 @@ Instrumentation agents:
 
 ## Activation and Configuration
 
-The following methods are supported to manually activate and configure Auto Instrumentation after installation of the
-`opentelemetry-injector` deb/rpm package (requires `root` privileges):
-
-- [System-wide](#system-wide-or-per-process)
-- [`Systemd` services only](#systemd-services-only)
-
-> **Note**: To prevent conflicts and duplicate traces/metrics, only one method should be activated on the target system.
-
-### System-wide or per process
+This method requires `root` privileges.
 
 1. Add the path of the provided `/usr/lib/opentelemetry/libotelinject.so` shared object library to the
    [`/etc/ld.so.preload`](https://man7.org/linux/man-pages/man8/ld.so.8.html#FILES) file to activate Auto
@@ -121,59 +113,6 @@ Check the following for details about the auto-instrumtation agents and further
 - [Node.js](https://opentelemetry.io/docs/zero-code/js/configuration/)
 - [.NET](https://opentelemetry.io/docs/zero-code/dotnet/configuration/)
 
-### `Systemd` services only
-
-> **Note**: The following steps utilize a sample `systemd` drop-in file to activate/configure the provided agents for
-> all `systemd` services via default environment variables. `Systemd` supports many options, methods, and paths for
-> configuring environment variables at the system level or for individual services, and are not limited to the steps
-> below. Before making any changes, it is recommended to consult the documentation specific to your Linux distribution
-> or service, and check the existing configurations of the system and individual services for potential conflicts or to
-> override an environment variable for a particular service. For general details about `systemd`, see the
-> [`systemd` man page](https://www.freedesktop.org/software/systemd/man/index.html).
-
-1. Copy the provided sample `systemd` drop-in file
-   `/usr/lib/opentelemetry/examples/systemd/00-otelinject-instrumentation.conf` to the host's `systemd`
-   [drop-in configuration directory](https://www.freedesktop.org/software/systemd/man/systemd-system.conf.html) to
-   activate Auto Instrumentation for ***all*** supported applications running as `systemd` services. For example:
-   ```
-   mkdir -p /usr/lib/systemd/system.conf.d/ && cp /usr/lib/opentelemetry/examples/systemd/00-otelinject-instrumentation.conf /usr/lib/systemd/system.conf.d/
-   ```
-   This file includes the required environment variables to activate the respective agents with the default options:
-   - Java:
-     ```
-     DefaultEnvironment="JAVA_TOOL_OPTIONS=-javaagent:/usr/lib/opentelemetry/otel-javaagent.jar"
-     ```
-   - Node.js:
-     ```
-     DefaultEnvironment="NODE_OPTIONS=-r /usr/lib/opentelemetry/otel-js/node_modules/@opentelemetry/auto-instrumentations-node/register"
-     ```
-   - .NET
-     ```
-     DefaultEnvironment="CORECLR_ENABLE_PROFILING=1"
-     DefaultEnvironment="CORECLR_PROFILER={918728DD-259F-4A6A-AC2B-B85E1B658318}"
-     DefaultEnvironment="CORECLR_PROFILER_PATH=/usr/lib/opentelemetry/otel-dotnet/linux-x64/OpenTelemetry.AutoInstrumentation.Native.so"
-     DefaultEnvironment="DOTNET_ADDITIONAL_DEPS=/usr/lib/opentelemetry/otel-dotnet/AdditionalDeps"
-     DefaultEnvironment="DOTNET_SHARED_STORE=/usr/lib/opentelemetry/otel-dotnet/store"
-     DefaultEnvironment="DOTNET_STARTUP_HOOKS=/usr/lib/opentelemetry/otel-dotnet/net/OpenTelemetry.AutoInstrumentation.StartupHook.dll"
-     DefaultEnvironment="OTEL_DOTNET_AUTO_HOME=/usr/lib/opentelemetry/otel-dotnet"
-     ```
-2. To configure the activated agents, add/update [`DefaultEnvironment`](
-   https://www.freedesktop.org/software/systemd/man/systemd-system.conf.html#DefaultEnvironment=) within the target file
-   from the previous step for the desired environment variables. For example:
-   ```
-   cat <<EOH >> /usr/lib/systemd/system.conf.d/00-otelinject-instrumentation.conf
-   DefaultEnvironment="OTEL_EXPORTER_OTLP_ENDPOINT=http://127.0.0.1:4317"
-   DefaultEnvironment="OTEL_RESOURCE_ATTRIBUTES=deployment.environment=my_deployment_environment"
-   DefaultEnvironment="OTEL_SERVICE_NAME=my_service_name"
-   EOH
-   ```
-   Check the following for all supported environment variables and default values:
-   - [Java](https://opentelemetry.io/docs/zero-code/java/agent/configuration/)
-   - [Node.js](https://opentelemetry.io/docs/zero-code/js/configuration/)
-   - [.NET](https://opentelemetry.io/docs/zero-code/dotnet/configuration/)
-3. Reboot the system, or run `systemctl daemon-reload` and then restart the applicable `systemd` services for any
-   changes to take effect.
-
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md).

packaging/fpm/common.sh

@@ -18,8 +18,6 @@ libotelinject_INSTALL_PATH="${INSTALL_DIR}/libotelinject.so"
 JAVA_AGENT_INSTALL_PATH="${INSTALL_DIR}/javaagent.jar"
 CONFIG_DIR_REPO_PATH="${FPM_DIR}/etc/opentelemetry"
 CONFIG_DIR_INSTALL_PATH="/etc/opentelemetry"
-EXAMPLES_INSTALL_DIR="${INSTALL_DIR}/examples"
-EXAMPLES_DIR="${FPM_DIR}/examples"
 
 JAVA_AGENT_RELEASE_PATH="${FPM_DIR}/../java-agent-release.txt"
 JAVA_AGENT_RELEASE_URL="https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases"
@@ -145,8 +143,6 @@ setup_files_and_permissions() {
     sudo chmod -R 755 "$buildroot/$CONFIG_DIR_INSTALL_PATH"
 
     mkdir -p "$buildroot/$INSTALL_DIR"
-    cp -rf "$EXAMPLES_DIR" "$buildroot/$INSTALL_DIR/"
-    sudo chmod -R 755 "$buildroot/$EXAMPLES_INSTALL_DIR"
 
     sudo chown -R root:root "$buildroot"
 }