Skip to content

Commit ec15c38

Browse files
authored
Merge branch 'main' into rm-watsonx-api
2 parents 6b12d76 + 65ff72d commit ec15c38

File tree

6 files changed

+17
-17
lines changed

6 files changed

+17
-17
lines changed

troubleshoot/deployments/esf/elastic-serverless-forwarder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ For example, if you don’t increase the visibility timeout for an SQS queue as
2525

2626
## Prevent unexpected costs [preventing-unexpected-costs]
2727

28-
It is important to monitor the Elastic Serverless Forwarder Lambda function for timeouts to prevent unexpected costs. You can use the [AWS Lambda integration](https://docs.elastic.co/en/integrations/aws/lambda) for this. If the timeouts are constant, you should throttle the Lambda function to stop its execution before proceeding with any troubleshooting steps. In most cases, constant timeouts will cause the records and messages from the event triggers to go back to their sources and trigger the function again, which will cause further timeouts and force a loop that will incure unexpected high costs. For more information on throttling Lambda functions, refer to [AWS docs](https://docs.aws.amazon.com/lambda/latest/operatorguide/throttling.md).
28+
It is important to monitor the Elastic Serverless Forwarder Lambda function for timeouts to prevent unexpected costs. You can use the [AWS Lambda integration](https://docs.elastic.co/en/integrations/aws/lambda) for this. If the timeouts are constant, you should throttle the Lambda function to stop its execution before proceeding with any troubleshooting steps. In most cases, constant timeouts will cause the records and messages from the event triggers to go back to their sources and trigger the function again, which will cause further timeouts and force a loop that will incure unexpected high costs. For more information on throttling Lambda functions, refer to [AWS docs](https://docs.aws.amazon.com/lambda/latest/operatorguide/throttling.html).
2929

3030

3131
## Increase debug information [_increase_debug_information]

troubleshoot/elasticsearch/elasticsearch-client-java-api-client/typed-keys-serialization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ mapped_pages:
55

66
# Typed keys serialization [serialize-without-typed-keys]
77

8-
{{es}} search requests accept a `typed_key` parameter that allow returning type information along with the name in aggregation and suggestion results (see the [aggregations documentation](https://www.elastic.co/guide/en/elasticsearch/reference/master/search-aggregations.html#return-agg-type) for additional details).
8+
{{es}} search requests accept a `typed_key` parameter that allow returning type information along with the name in aggregation and suggestion results (see the [aggregations documentation](/explore-analyze/query-filter/aggregations.md#return-agg-type) for additional details).
99

1010
The Java API Client always adds this parameter to search requests, as type information is needed to know the concrete class that should be used to deserialize aggregation and suggestion results.
1111

troubleshoot/elasticsearch/security/trb-security-kerberos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Make sure that:
3636
* You have installed curl version 7.49 or above as older versions of curl have known Kerberos bugs.
3737
* The curl installed on your machine has `GSS-API`, `Kerberos` and `SPNEGO` features listed when you invoke command `curl -V`. If not, you will need to compile `curl` version with this support.
3838

39-
To download latest curl version visit [https://curl.haxx.se/download.html](https://curl.haxx.se/download.md)
39+
To download latest curl version visit [https://curl.haxx.se/download.html](https://curl.haxx.se/download.html)
4040

4141

4242
As Kerberos logs are often cryptic in nature and many things can go wrong as it depends on external services like DNS and NTP. You might have to enable additional debug logs to determine the root cause of the issue.

troubleshoot/elasticsearch/security/trb-security-maccurl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ mapped_pages:
1212

1313
**Resolution:**
1414

15-
Apple’s integration of `curl` with their keychain technology disables the `--cacert` option. See [http://curl.haxx.se/mail/archive-2013-10/0036.html](http://curl.haxx.se/mail/archive-2013-10/0036.md) for more information.
15+
Apple’s integration of `curl` with their keychain technology disables the `--cacert` option. See [http://curl.haxx.se/mail/archive-2013-10/0036.html](http://curl.haxx.se/mail/archive-2013-10/0036.html) for more information.
1616

1717
You can use another tool, such as `wget`, to test certificates. Alternately, you can add the certificate for the signing certificate authority MacOS system keychain, using a procedure similar to the one detailed at the [Apple knowledge base](http://support.apple.com/kb/PH14003). Be sure to add the signing CA’s certificate and not the server’s certificate.
1818

troubleshoot/observability/amazon-data-firehose.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The backup settings in the delivery stream specify how failed delivery requests
1616

1717
## Scaling [aws-firehose-troubleshooting-scaling]
1818

19-
Firehose can [automatically scale](https://docs.aws.amazon.com/firehose/latest/dev/limits.md) to handle very high throughput. If your Elastic deployment is not properly configured for the data volume coming from Firehose, it could cause a bottleneck, which may lead to increased ingest times or indexing failures.
19+
Firehose can [automatically scale](https://docs.aws.amazon.com/firehose/latest/dev/limits.html) to handle very high throughput. If your Elastic deployment is not properly configured for the data volume coming from Firehose, it could cause a bottleneck, which may lead to increased ingest times or indexing failures.
2020

2121
There are several facets to optimizing the underlying Elasticsearch performance, but Elastic Cloud provides several ready-to-use hardware profiles which can provide a good starting point. Other factors which can impact performance are [shard sizing](../../deploy-manage/production-guidance/optimize-performance/size-shards.md), [indexing configuration](../../deploy-manage/production-guidance/optimize-performance/indexing-speed.md), and [index lifecycle management (ILM)](../../manage-data/lifecycle/index-lifecycle-management.md).
2222

troubleshoot/observability/apm-agent-python/apm-python-agent.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ Below are some resources and tips for troubleshooting and debugging the python a
1414
* [Disable the Agent](#disable-agent)
1515

1616

17-
## Easy Fixes [easy-fixes]
17+
## Easy Fixes [easy-fixes]
1818

1919
Before you try anything else, go through the following sections to ensure that the agent is configured correctly. This is not an exhaustive list, but rather a list of common problems that users run into.
2020

2121

22-
### Debug Mode [debug-mode]
22+
### Debug Mode [debug-mode]
2323

2424
Most frameworks support a debug mode. Generally, this mode is intended for non-production environments and provides detailed error messages and logging of potentially sensitive data. Because of these security issues, the agent will not collect traces if the app is in debug mode by default.
2525

@@ -34,7 +34,7 @@ apm = ElasticAPM(app, service_name="flask-app")
3434
```
3535

3636

37-
### `psutil` for Metrics [psutil-metrics]
37+
### `psutil` for Metrics [psutil-metrics]
3838

3939
To get CPU and system metrics on non-Linux systems, `psutil` must be installed. The agent should automatically show a warning on start if it is not installed, but sometimes this warning can be suppressed. Install `psutil` and metrics should be collected by the agent and sent to the APM Server.
4040

@@ -43,19 +43,19 @@ python3 -m pip install psutil
4343
```
4444

4545

46-
### Credential issues [apm-server-credentials]
46+
### Credential issues [apm-server-credentials]
4747

4848
In order for the agent to send data to the APM Server, it may need an [`API_KEY`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-api-key) or a [`SECRET_TOKEN`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-secret-token). Double check your APM Server settings and make sure that your credentials are configured correctly. Additionally, check that [`SERVER_URL`](asciidocalypse://docs/apm-agent-python/docs/reference/configuration.md#config-server-url) is correct.
4949

5050

51-
## Django `check` and `test` [django-test]
51+
## Django `check` and `test` [django-test]
5252

5353
When used with Django, the agent provides two management commands to help debug common issues. Head over to the [Django troubleshooting section](asciidocalypse://docs/apm-agent-python/docs/reference/django-support.md#django-troubleshooting) for more information.
5454

5555

56-
## Agent logging [agent-logging]
56+
## Agent logging [agent-logging]
5757

58-
To get the agent to log more data, all that is needed is a [Handler](https://docs.python.org/3/library/logging.md#handler-objects) which is attached either to the `elasticapm` logger or to the root logger.
58+
To get the agent to log more data, all that is needed is a [Handler](https://docs.python.org/3/library/logging.html#handler-objects) which is attached either to the `elasticapm` logger or to the root logger.
5959

6060
Note that if you attach the handler to the root logger, you also need to explicitly set the log level of the `elasticapm` logger:
6161

@@ -66,7 +66,7 @@ apm_logger.setLevel(logging.DEBUG)
6666
```
6767

6868

69-
### Django [django-agent-logging]
69+
### Django [django-agent-logging]
7070

7171
The simplest way to log more data from the agent is to add a console logging Handler to the `elasticapm` logger. Here’s a (very simplified) example:
7272

@@ -88,14 +88,14 @@ LOGGING = {
8888
```
8989

9090

91-
### Flask [flask-agent-logging]
91+
### Flask [flask-agent-logging]
9292

9393
Flask [recommends using `dictConfig()`](https://flask.palletsprojects.com/en/1.1.x/logging/) to set up logging. If you’re using this format, adding logging for the agent will be very similar to the [instructions for Django above](#django-agent-logging).
9494

9595
Otherwise, you can use the [generic instructions below](#generic-agent-logging).
9696

9797

98-
### Generic instructions [generic-agent-logging]
98+
### Generic instructions [generic-agent-logging]
9999

100100
Creating a console Handler and adding it to the `elasticapm` logger is easy:
101101

@@ -119,10 +119,10 @@ console_handler.setLevel(logging.DEBUG)
119119
logger.addHandler(console_handler)
120120
```
121121

122-
See the [python logging docs](https://docs.python.org/3/library/logging.md) for more details about Handlers (and information on how to format your logs using Formatters).
122+
See the [python logging docs](https://docs.python.org/3/library/logging.html) for more details about Handlers (and information on how to format your logs using Formatters).
123123

124124

125-
## Disable the Agent [disable-agent]
125+
## Disable the Agent [disable-agent]
126126

127127
In the unlikely event the agent causes disruptions to a production application, you can disable the agent while you troubleshoot.
128128

0 commit comments

Comments
 (0)