Skip to content
This repository was archived by the owner on Apr 13, 2023. It is now read-only.

Commit e29bccc

Browse files
authored
chore: add docs on troubleshooting logs (#517)
1 parent 4646c8f commit e29bccc

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

.github/workflows/codeql-analysis.yml

-3
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,6 @@ on:
1010
branches:
1111
- develop
1212
- smart-develop
13-
paths-ignore:
14-
- '**/*.md'
15-
- '**/*.txt'
1613
push:
1714
branches:
1815
- develop

DEVELOPMENT.md

+20
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,23 @@ Then `package.json` should have the same versions specified as well:
9494
```
9595

9696
If you have a mismatch in `package.json`, say `fhir-works-on-aws-routing` was set to `4.1.0` instead of `4.0.0`. An error message
97+
98+
### Accessing Logs and Debugging on FWoA
99+
Logs and Debugging are handled by [CloudWatch](https://docs.aws.amazon.com/cloudwatch/index.html). Detailed instructions on customizing CloudWatch to organize troubleshooting can be found [here](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html).
100+
101+
To access the logs generated by FWoA:
102+
1. Log on to the AWS Console.
103+
2. From the list of AWS services, select **CloudWatch**.
104+
3. From the tab on the left, select **Log Groups**
105+
4. From the list of log groups, select the Lambda Function or the APIGateway service that you would like to debug.
106+
* `/aws/lambda/fhir-service-{STAGE}-fhirServer` contains all the logs from the FWoA API server, including transactions and requests. This will be the log group to check when receiving errors from the FWoA server, in most cases.
107+
* `/aws/api-gateway/fhir-service-{STAGE}` contains all the logs related to the setup of the API Gateway for FWoA.
108+
* `/aws/lambda/fhir-service-{STAGE}-ddbtoES` contains all the logs from the process of writing DynamoDB resources to ElasticSearch.
109+
* `/aws-glue/jobs/output` contains all the logs related to the Bulk Export Glue Job execution.
110+
* `/aws/lambda/fhir-service-{STAGE}-getJobStatus` contains all the logs related to querying the status of a Bulk Export job.
111+
* `/aws/lambda/fhir-service-{STAGE}-startExportJob` contains all the logs related to starting a Bulk Export job.
112+
* `/aws/lambda/fhir-service-{STAGE}-stopExportJob` contains all the logs related to stopping a Bulk Export job.
113+
* `/aws/lambda/fhir-service-{STAGE}-updateStatus` contains all the logs related to updating a Bulk Export job.
114+
* `/aws/lambda/fhir-service-validator-{STAGE}-validator` contains all the logs pertaining to validation and implementation guides. These are useful in troubleshooting custom resources and implementation guides.
115+
5. Select a stream to view the output for the function. If applicable, the version of the Lambda function will be prefixed in square brackets (`[]`) to help identify which stream corresponds to which version.
116+
6. To further refine the output of the function, the events in a stream can be filtered using the options at the top of the list. In addition, you can perform broader searches through the **Log Insights** option on the tab on the left, underneath **Log Groups**.

0 commit comments

Comments
 (0)