Merge branch 'main' of github.com:Baselime/docs

_includes/head.html

@@ -1 +1,8 @@
 <script defer data-domain="baselime.io" src="https://plausible.io/js/plausible.js"></script>
+<script type="text/javascript">
+  (function(c,l,a,r,i,t,y){
+      c[a]=c[a]||function(){(c[a].q=c[a].q||[]).push(arguments)};
+      t=l.createElement(r);t.async=1;t.src="https://www.clarity.ms/tag/"+i;
+      y=l.getElementsByTagName(r)[0];y.parentNode.insertBefore(t,y);
+  })(window, document, "clarity", "script", "hr34nq4ago");
+</script>

advanced/materialized-keys.md

@@ -7,8 +7,6 @@ order: -3
 
 Materialized keys in Baselime allow you to calculate and create new keys from existing keys in your events. These new keys are based on calculations performed on one or multiple existing keys, which must be of type `number`.
 
-By creating materialized keys, you can gain additional insights into your data and make it easier to track and analyze specific metrics.
-
 To create a materialized key, you can use the `baselime keys materialize` command and specify the key name and calculation you want to perform. For example
 
 ```bash # :icon-terminal: terminal

analysing-data/alerts.md

@@ -55,8 +55,7 @@ When an alert is triggered, you can choose to receive notifications through a va
 3. Set up alerts for the right things: Make sure to set up alerts for the most important issues that need immediate attention.
 4. Use multiple alerting methods: Use a combination of Slack, email, and webhooks to ensure that you are notified of important issues in a timely manner.
 5. Use alert suppression: Silence repeated alerts to avoid alert fatigue and ensure that you are only notified of important issues.
-6. Use alert grouping: Use alert grouping to group related alerts together, making it easier to triage and resolve issues.
-7. Consider using webhook alerts to build self-healing systems
-8. Test your alerts to ensure they are working as expected.
-9. Use alert analytics: Use alert analytics to analyze the effectiveness of your alerting strategy and make improvements where necessary.
-10. Regularly review and update alert thresholds and configurations to ensure they are still relevant and effective.
+6. Consider using webhook alerts to build self-healing systems
+7. Test your alerts to ensure they are working as expected.
+8. Use alert analytics: Use alert analytics to analyze the effectiveness of your alerting strategy and make improvements where necessary.
+9. Regularly review and update alert thresholds and configurations to ensure they are still relevant and effective.

analysing-data/baselime-ai.md

@@ -5,7 +5,7 @@ order: 2
 
 # Baselime AI
 
-Baselime AI provides explanations for any chart, log, event, metric or trace on Baselime. It helps you easily identify patterns and anomalies in your serverless systems, providing deeper insights into your system performance and behavior.
+Baselime AI provides explanations for any chart, log, event, metric or trace on Baselime. It enables you to identify patterns and anomalies in your serverless systems, providing deeper insights into your system performance and behavior.
 
 ---
 
@@ -27,17 +27,17 @@ Once you have an account, follow these steps to use Baselime AI:
 
 Baselime AI is built using OpenAI's Large Language Models. When you ask Baselime AI a question, it analyzes the data in the selected chart or event, and uses machine learning algorithms to identify any anomalies or patterns.
 
-Once Baselime AI has identified potential issues, it generates a response that explains the root cause of the problem, as well as any recommended actions to fix it. The response is presented in natural language, making it easy for developers of all skill levels to understand.
+Once Baselime AI has identified potential issues, it generates a response that explains the root cause of the problem, as well as any recommended actions to fix it. The response is presented in natural language, enabling developers of all skill levels to understand.
 
 ---
 
 ## Benefits
 
 Baselime AI offers a range of benefits, including:
 
-- Streamlined debugging: Baselime AI enables you to quickly and easily identify and fix issues, reducing the time and effort required for debugging.
+- Streamlined debugging: Baselime AI enables you to quickly identify and fix issues, reducing the time and effort required for debugging.
 - Improved system observability: With Baselime AI, you can gain deeper insights into your system performance and behavior, enabling you to optimize your systems and improve overall system observability.
-- Accessible to all skill levels: Baselime AI's natural language explanations make it easy for developers at all skill levels to understand and interpret results.
+- Accessible to all skill levels: Baselime AI's natural language explanations enable developers at all skill levels to understand and interpret results.
 
 ---
 

analysing-data/queries.md

@@ -11,7 +11,7 @@ Queries are the primary way of interacting with your data in Baselime.
 
 You can run queries in the [Baselime console](https://console.baselime.io) by navigating to your service and clicking on the New Query button. This will bring up the Visual Query Editor. You can edit the query visually, but also switch to the embedded code editor to write your query using the [Observability Reference Language (ORL)](../oac/observability-reference-language/overview.md).
 
-To execute a query, simply click the Run Query button. The query results will be displayed in visually and in a table below the editor.
+To execute a query, click the Run Query button. The query results will be displayed in visually and in a table below the editor.
 
 [!embed](https://www.youtube.com/watch?v=QuLT55XqJsE)
 

analysing-data/service-discovery.md

@@ -30,4 +30,4 @@ Services also enable you to organise your queries, alerts and dashboards within
 
 ## Querying Telemetry Data
 
-Baselime's Service Discovery also makes querying much faster. Instead of searching through a large amount of data to find the information you need, you can simply query the data for a specific service. This accelerate your debugging and makes it easier to identify issues and troubleshoot problems in your application.
+Baselime's Service Discovery also makes querying much faster. Instead of searching through a large amount of data to find the information you need, you can query the data for a specific service. This accelerate your debugging and helps you identify issues and troubleshoot problems in your application.

analysing-data/snapshots.md

@@ -9,7 +9,7 @@ Snapshots enable you to capture the current state of all your alerts in a servic
 
 ## Using Snapshots
 
-To create a snapshot, simply run the `baselime test` command in your terminal. This will create a snapshot of the current state of all alerts in the current service, display the results in the terminal, and output them to a file in JSON format. You can specify the output file path using the `--out-file` flag.
+To create a snapshot, run the `baselime test` command in your terminal. This will create a snapshot of the current state of all alerts in the current service, display the results in the terminal, and output them to a file in JSON format. You can specify the output file path using the `--out-file` flag.
 
 ```bash # :icon-terminal: terminal
 baselime test --service my-service --out-file snapshot.json

cli/reference/mark.md

@@ -0,0 +1,33 @@
+---
+label: mark
+---
+
+# baselime mark
+
+Use the `baselime mark` command to create a marker.
+
+```bash :icon-terminal: terminal
+baselime mark
+
+Creates a marker
+
+Options:
+      --profile  [string] [default: "default"]
+      --quiet  [boolean] [default: false]
+      --debug  [boolean] [default: false]
+      --format       Format to output the data in  [string] [choices: "table", "json"] [default: "table"]
+      --service      The service to add the marker to  [string] [default: "default"]
+      --url          The URL associated with this specific marker  [string]
+      --name         The name of this specific marker  [string] [default: "created-by-baselime-cli"]
+      --description  The description of this specific marker  [string]
+      --start-time   The start time for the marker in unix time (milliseconds since the epoch). Defaults to now  [number]
+      --end-time     The end time for the marker in unix time (milliseconds since the epoch)  [number]
+  -h, --help         Show this help output, or the help for a specified command or subcommand  [boolean]
+  -v, --version      Show the current Baselime CLI version  [boolean]
+
+Examples:
+
+        # Creates a marker
+        baselime mark --service <service_name> --url <marker_url> --description <description>
+
+```

cli/reference/rehydrate.md

@@ -4,25 +4,26 @@ label: rehydrate
 
 # baselime rehydrate
 
-Use the `baselime rehydrate` to rehydrate expired data from your S3.
+Use the `baselime rehydrate` to rehydrate Baselime hot storage with data from your Amazon S3 Bucket.
 
 ```bash :icon-terminal: terminal
 baselime rehydrate
 
-Rehydrate expired data from your s3
+Rehydrate Baselime hot storage with data from your Amazon S3 Bucket
 
 Options:
       --profile  [string] [default: "default"]
       --quiet  [boolean] [default: false]
       --debug  [boolean] [default: false]
-      --format          Format to output the data in  [string] [choices: "table", "json"] [default: "table"]
-      --startDate       Date onwards which to recover the data ISO format  [string]
-      --hoursToRecover  Consecutive hours of data from startDate to recover  [number]
-  -h, --help            Show this help output, or the help for a specified command or subcommand  [boolean]
-  -v, --version         Show the current Baselime CLI version  [boolean]
+      --format            Format to output the data in  [string] [choices: "table", "json"] [default: "table"]
+      --start-date        Date to start recovering data from, in ISO format  [string]
+      --hours-to-recover  Number of consecutive hours of data to recover starting from start-date. Minimum: 1, maximum: 12  [number]
+  -h, --help              Show this help output, or the help for a specified command or subcommand  [boolean]
+  -v, --version           Show the current Baselime CLI version  [boolean]
 
 Examples:
 
-        baselime rehydrate --startDate 2023-06-08T13:24:47.906Z --hoursToRecover 1
-        baselime rehydrate --profile prod --startDate 2023-06-08T13:24:47.906Z --hoursToRecover 1
+        baselime rehydrate --start-date 2023-06-08T13:24:47.906Z --hours-to-recover 1
+        baselime rehydrate --profile prod --start-date 2023-06-08T13:24:47.906Z --hours-to-recover 9
+
 ```

oac/observability-reference-language/overview.md

@@ -17,6 +17,6 @@ Multiple integrations and connectors with your favourite Infrastructure as Code
 
 ## Best Practice
 
-To streamline your Observability workflows, we recommend keeping your `.baselime` folder in Git alongside your source code. This enables you to easily sync and version control your queries, alerts and dashboards, and collaborate with other team members.
+To streamline your Observability workflows, we recommend keeping your `.baselime` folder in Git alongside your source code. This enables you to sync and version control your queries, alerts and dashboards, and collaborate with other team members.
 
-To pull the pregenerated queries and dashboards to your local machine, simply run `baselime pull` using the Baselime CLI. If the service has not been initialized locally, the CLI will prompt you to select the relevant service from a list of all your services. Once selected, Baselime will download all the queries, alerts, and dashboards for that service, enabling you to work with them locally.
+To pull the pregenerated queries and dashboards to your local machine, run `baselime pull` using the Baselime CLI. If the service has not been initialized locally, the CLI will prompt you to select the relevant service from a list of all your services. Once selected, Baselime will download all the queries, alerts, and dashboards for that service, enabling you to work with them locally.

oac/observability-reference-language/reference/dashboards.md

@@ -77,7 +77,7 @@ widgets:
 
 In ORL, there are three types of widget views:
 
-- `calculations`: This view presents your data as easy-to-read line charts, enabling you to quickly calculate key performance metrics like averages, sums, and counts.
+- `calculations`: This view presents your data as line charts, enabling you to quickly calculate key performance metrics like averages, sums, and counts.
 - `events`: This view allows you to explore individual events by filtering and searching, making it a valuable tool for investigating specific occurrences and trends.
 - `traces`: This view provides a scatter plot of distributed traces, giving you insights into bottlenecks and latency issues. It's perfect for investigating specific requests or flows and optimizing performance.