Skip to content

Commit ba83349

Browse files
Fix link to integratio options docs and headings
1 parent 5623b7a commit ba83349

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ These are the most important files:
116116
## Configuration Options
117117
The following sections describe the available configuration options for this middleware. You can set these options in a Python object and then pass that object as argument to the `MoesifLogger` decorator. See [the sample AWS Lambda middleware function code](https://github.com/Moesif/moesif-aws-lambda-python/blob/857af6d4c12be8681e569f42317043c51acc2341/lambda_function.py#L6) for an example.
118118

119-
### __`IDENTIFY_USER`__
119+
### `IDENTIFY_USER`
120120
<table>
121121
<tr>
122122
<th scope="col">
@@ -154,7 +154,7 @@ def identify_user(event, context):
154154
return event["requestContext"]["identity"]["cognitoIdentityId"]
155155
```
156156

157-
### __`IDENTIFY_COMPANY`__
157+
### `IDENTIFY_COMPANY`
158158

159159
<table>
160160
<tr>
@@ -195,7 +195,7 @@ def identify_company(event, context):
195195
}
196196
```
197197

198-
### __`GET_SESSION_TOKEN`__
198+
### `GET_SESSION_TOKEN`
199199

200200
<table>
201201
<tr>
@@ -231,7 +231,7 @@ def get_session_token(event, context):
231231
return 'XXXXXXXXX'
232232
```
233233

234-
### __`GET_API_VERSION`__
234+
### `GET_API_VERSION`
235235
<table>
236236
<tr>
237237
<th scope="col">
@@ -266,7 +266,7 @@ def get_api_version(event, context):
266266
return '1.0.0'
267267
```
268268

269-
### __`GET_METADATA`__
269+
### `GET_METADATA`
270270
<table>
271271
<tr>
272272
<th scope="col">
@@ -310,7 +310,7 @@ def get_metadata(event, context):
310310
}
311311
```
312312

313-
### __`SKIP`__
313+
### `SKIP`
314314
<table>
315315
<tr>
316316
<th scope="col">
@@ -348,7 +348,7 @@ def should_skip(event, context):
348348
return "/" in event['path']
349349
```
350350

351-
### __`MASK_EVENT_MODEL`__
351+
### `MASK_EVENT_MODEL`
352352
<table>
353353
<tr>
354354
<th scope="col">
@@ -393,7 +393,7 @@ For more information about the different fields of Moesif's event model,
393393
see [Moesif Python API documentation](https://www.moesif.com/docs/api?python).
394394

395395

396-
### __`DEBUG`__
396+
### `DEBUG`
397397
<table>
398398
<tr>
399399
<th scope="col">
@@ -416,7 +416,7 @@ see [Moesif Python API documentation](https://www.moesif.com/docs/api?python).
416416
Set to `True` to print debug logs if you're having integration issues.
417417

418418

419-
### __`LOG_BODY`__
419+
### `LOG_BODY`
420420
<table>
421421
<tr>
422422
<th scope="col">
@@ -431,7 +431,7 @@ Set to `True` to print debug logs if you're having integration issues.
431431
<code>Boolean</code>
432432
</td>
433433
<td>
434-
<code>true</code>
434+
<code>True</code>
435435
</td>
436436
</tr>
437437
</table>
@@ -452,7 +452,7 @@ start_capture_outgoing(moesif_options) # moesif_options are the configuration op
452452

453453
The following options are available for capturing and logging outgoing calls. The request and response objects passed in correspond to the [`Request` and `Response` objects](https://requests.readthedocs.io/en/master/user/advanced/#request-and-response-objects) respectively of the Python Requests library.
454454

455-
#### __`SKIP_OUTGOING`__
455+
#### `SKIP_OUTGOING`
456456
<table>
457457
<tr>
458458
<th scope="col">
@@ -481,7 +481,7 @@ Optional.
481481

482482
This function takes Requests [`Request` and `Response` objects](https://requests.readthedocs.io/en/latest/user/advanced/#request-and-response-objects) and returns `True` if you want to skip this particular event.
483483

484-
#### __`IDENTIFY_USER_OUTGOING`__
484+
#### `IDENTIFY_USER_OUTGOING`
485485
<table>
486486
<tr>
487487
<th scope="col">
@@ -513,7 +513,7 @@ This function takes Requests [`Request` and `Response` objects](https://requests
513513
the user ID used by your system. While Moesif tries to identify users automatically, different frameworks and your implementation might be very different. So we highly recommend that you accurately provide a
514514
user ID using this function.
515515

516-
#### __`IDENTIFY_COMPANY_OUTGOING`__
516+
#### `IDENTIFY_COMPANY_OUTGOING`
517517
<table>
518518
<tr>
519519
<th scope="col">
@@ -544,7 +544,7 @@ Optional.
544544
This function takes Requests [`Request` and `Response` objects](https://requests.readthedocs.io/en/latest/user/advanced/#request-and-response-objects) and returns a string that represents
545545
the company ID for this event.
546546

547-
#### __`GET_METADATA_OUTGOING`__
547+
#### `GET_METADATA_OUTGOING`
548548
<table>
549549
<tr>
550550
<th scope="col">
@@ -578,7 +578,7 @@ valid JSON. This allows you to associate this event with custom metadata.
578578

579579
For example, you may want to save a virtual machine instance ID, a trace ID, or a tenant ID with the request.
580580

581-
#### __`GET_SESSION_TOKEN_OUTGOING`__
581+
#### `GET_SESSION_TOKEN_OUTGOING`
582582

583583
<table>
584584
<tr>
@@ -609,7 +609,7 @@ Optional.
609609

610610
This function takes Requests [`Request` and `Response` objects](https://requests.readthedocs.io/en/latest/user/advanced/#request-and-response-objects) and returns a string that represents the session token for this event. Similar to [user IDs](#identify_user_outgoing), Moesif tries to get the session token automatically. However, if you setup differs from the standard, this function can help tying up events together and help you replay the events.
611611

612-
#### __`LOG_BODY_OUTGOING`__
612+
#### `LOG_BODY_OUTGOING`
613613
<table>
614614
<tr>
615615
<th scope="col">
@@ -624,7 +624,7 @@ This function takes Requests [`Request` and `Response` objects](https://requests
624624
<code>Boolean</code>
625625
</td>
626626
<td>
627-
<code>true</code>
627+
<code>True</code>
628628
</td>
629629
</tr>
630630
</table>
@@ -835,7 +835,7 @@ See [Moesif AWS Lambda Example for Python](https://github.com/Moesif/moesif-aws-
835835
If you face any issues using this middleware, try the [troubheshooting guidelines](#troubleshoot). For further assistance, reach out to our [support team](mailto:support@moesif.com).
836836

837837
## Explore Other integrations
838-
Explore other integration options from Moesif in [the Server Integration Options documentation](https://www.moesif.com/docs/getting-started/integration-options/).
838+
Explore other integration options from Moesif in [the Server Integration Options documentation](https://www.moesif.com/docs/server-integration/).
839839

840840
[ico-built-for]: https://img.shields.io/badge/built%20for-aws%20lambda-blue.svg
841841
[ico-license]: https://img.shields.io/badge/License-Apache%202.0-green.svg

0 commit comments

Comments
 (0)