Skip to content

Commit

Permalink
Update serverless logs pages with bug bash updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mdbirnstiehl committed Nov 19, 2024
1 parent e50758f commit 31e79a9
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 68 deletions.
7 changes: 2 additions & 5 deletions docs/en/serverless/logging/get-started-with-logs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,8 @@ To onboard system log data:

. <<observability-create-an-observability-project,Create a new {obs-serverless} project>>, or open an existing one.
. In your {obs-serverless} project, go to **Add data**.
. Under **Collect and analyze logs**, click **Stream host system logs**.
When the page loads, the system integration is installed automatically, and a new API key is created.
Make sure you copy the API key and store it in a secure location.
. Follow the in-product steps to install and configure the {agent}.
Notice that you can choose to download the agent's config automatically to avoid adding it manually.
. Under **What do you want to monitor?**, select **Host** → **Elastic Agent: Logs & Metrics**.
. Follow the in-product steps to auto-detect your logs and install and configure the {agent}.

After the agent is installed and successfully streaming log data, you can view the data in the UI:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Log pattern analysis works on every text field.
To run a log pattern analysis:

. In your {obs-serverless} project, go to **Discover** and select the **Logs Explorer** tab.
. Select an integration, for example **Elastic APM error_logs**, and apply any filters that you want.
. Select an integration, and apply any filters that you want.
. If you don't see any results, expand the time range, for example, to **Last 15 days**.
. In the **Available fields** list, select the text field you want to analyze, then click **Run pattern analysis**.
+
Expand Down
62 changes: 1 addition & 61 deletions docs/en/serverless/logging/stream-log-files.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,72 +30,12 @@ The quickest way to get started is to:

. Open your Observability project. If you don't have one, <<observability-create-an-observability-project,create an observability project>>.
. Go to **Add Data**.
. Under **Collect and analyze logs**, click **Stream log files**.
. Under **What do you want to monitor?**, select **Host** → **Elastic Agent: Logs & Metrics**.

This will kick off a set of guided instructions that walk you through configuring the standalone {agent} and sending log data to your project.

To install and configure the {agent} manually, refer to <<manually-install-agent-logs,Manually install and configure the standalone {agent}>>.

[discrete]
[[observability-stream-log-files-configure-inputs-and-integration]]
== Configure inputs and integration

Enter a few configuration details in the guided instructions.

// Do we want to include a screenshot or will it be too difficult to maintain?

[role="screenshot"]
image::images/logs-stream-logs-config.png[Configure inputs and integration in the Stream log files guided instructions]

**Configure inputs**

* **Log file path**: The path to your log files.
You can also use a pattern like `/var/log/your-logs.log*`.
Click **Add row** to add more log file paths.
+
This will be passed to the `paths` field in the generated `elastic-agent.yml` file in a future step.
+
* **Service name**: Provide a service name to allow for distributed services running on
multiple hosts to correlate the related instances.

// Advanced settings?

**Configure integration**

Elastic creates an integration to streamline connecting your log data to Elastic.

* **Integration name**: Give your integration a name.
This is a unique identifier for your stream of log data that you can later use to filter data in Logs Explorer.
The value must be unique within your project, all lowercase, and max 100 chars. Special characters will be replaced with `_`.
+
This will be passed to the `streams.id` field in the generated `elastic-agent.yml` file in a future step.
+
The integration name will be used in Logs Explorer.
It will appear in the "All logs" dropdown menu.
+
[role="screenshot"]
image:images/logs-stream-logs-service-name.png[All logs dropdown menu on Logs Explorer page]
+
* **Dataset name**: Give your integration's dataset a name.
The name for your dataset data stream. Name this data stream anything that signifies the source of the data.
The value must be all lowercase and max 100 chars. Special characters will be replaced with `_`.
+
This will be passed to the `data_stream.dataset` field in the generated `elastic-agent.yml` file in a future step.

[discrete]
[[observability-stream-log-files-install-the-agent]]
== Install the {agent}

After configuring the inputs and integration, you'll continue in the guided instructions to
install and configure the standalone {agent}.

Run the command under **Install the {agent}** that corresponds with your system to download, extract, and install the {agent}.
Turning on **Automatically download the agent's config** includes your updated {agent} configuration file in the download.

If you do not want to automatically download the configuration, click **Download config file** to download it manually and
add it to `/opt/Elastic/Agent/elastic-agent.yml` on the host where you installed the {agent}.
The values you provided in <<observability-stream-log-files-configure-inputs-and-integration,Configure inputs and integration>> will be prepopulated in the generated configuration file.

[discrete]
[[manually-install-agent-logs]]
== Manually install and configure the standalone {agent}
Expand Down
2 changes: 1 addition & 1 deletion docs/en/serverless/logging/troubleshoot-logs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ You need permission to manage API keys

You need to either:

* Ask an administrator to update your user role to at least **Deployment access** → **Admin**. Read more about user roles in <<general-assign-user-roles>>. After your use role is updated, restart the onboarding flow.
* Ask an administrator to update your user role to at least **Developer** by going to the user icon on the header bar and opening **Organization** → **Members**. Read more about user roles in <<general-assign-user-roles>>. After your use role is updated, restart the onboarding flow.
* Get an API key from an administrator and manually add the API to the {agent} configuration. See <<observability-stream-log-files-step-3-configure-the-agent,Configure the {agent}>> for more on manually updating the configuration and adding the API key.

// Not sure if these are different in serverless...
Expand Down

0 comments on commit 31e79a9

Please sign in to comment.