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

Commit d28c142

Browse files
authored
Small formatting fixes in README
1 parent 5a90adb commit d28c142

File tree

1 file changed

+23
-24
lines changed

1 file changed

+23
-24
lines changed

README.rst

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -15,26 +15,26 @@ Installation
1515

1616
To install from PyPi
1717

18-
::
18+
.. code::
1919
20-
$ pip install signalfx_lambda
20+
pip install signalfx_lambda
2121
2222
Configuring the ingest endpoint
2323
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2424

25-
By default, this function wrapper will send to the `us0` realm. If you are
26-
not in this realm you will need to set the `SIGNALFX_INGEST_ENDPOINT` environment
27-
variable to the correct realm ingest endpoint (https://ingest.{REALM}.signalfx.com).
25+
By default, this function wrapper will send to the ``us0`` realm. If you are
26+
not in this realm you will need to set the ``SIGNALFX_INGEST_ENDPOINT`` environment
27+
variable to the correct realm ingest endpoint (``https://ingest.{REALM}.signalfx.com``).
2828
To determine what realm you are in, check your profile page in the SignalFx
2929
web application (click the avatar in the upper right and click My Profile).
3030

3131

3232
Environment Variables
3333
~~~~~~~~~~~~~~~~~~~~~
3434

35-
**Note: the environment variables SIGNALFX_INGEST_ENDPOINT and SIGNALFX_AUTH_TOKEN are being deprecated and will not be supported in future releases.**
35+
**Note: the environment variables ``SIGNALFX_INGEST_ENDPOINT`` and ``SIGNALFX_AUTH_TOKEN`` are being deprecated and will not be supported in future releases.**
3636

37-
::
37+
.. code:: bash
3838
3939
SIGNALFX_ACCESS_TOKEN=access token
4040
@@ -49,27 +49,26 @@ Environment Variables
4949
5050
SIGNALFX_TRACING_URL=tracing endpoint [ default: https://ingest.signalfx.com/v1/trace ]
5151
52-
SIGNALFX_ENDPOINT_URL can be used to configure a common endpoint for metrics and
53-
traces, as is the case when forwarding with the Smart Gateway. The path :code:`/v1/traces`
52+
``SIGNALFX_ENDPOINT_URL`` can be used to configure a common endpoint for metrics and
53+
traces, as is the case when forwarding with the Smart Gateway. The path ``/v1/traces``
5454
will automatically be added to the endpoint for traces.
5555

56-
If either SIGNALFX_TRACING_URL or SIGNALFX_METRICS_URL are set, they will take
57-
precendence over SIGNALFX_ENDPOINT_URL for their respective components.
56+
If either ``SIGNALFX_TRACING_URL`` or ``SIGNALFX_METRICS_URL`` are set, they will take
57+
precendence over ``SIGNALFX_ENDPOINT_URL`` for their respective components.
5858

59-
For example, if only SIGNALFX_ENDPOINT_URL is set:
59+
For example, if only ``SIGNALFX_ENDPOINT_URL`` is set:
6060

61-
::
61+
.. code:: bash
6262
6363
SIGNALFX_ENDPOINT_URL=http://<my_gateway>:8080
6464
65-
both metrics and traces will be sent to the gateway address.
65+
Both metrics and traces will be sent to the gateway address.
6666

67-
If SIGNALFX_ENDPOINT_URL and SIGNALFX_METRICS_URL are set:
67+
If ``SIGNALFX_ENDPOINT_URL`` and ``SIGNALFX_METRICS_URL`` are set:
6868

69-
::
69+
.. code:: bash
7070
7171
SIGNALFX_METRICS_URL=https://pops.signalfx.com
72-
7372
SIGNALFX_ENDPOINT_URL=http://<my_gateway>:8080
7473
7574
Traces will be sent to the gateway and metrics will go through POPS.
@@ -81,7 +80,7 @@ There are two wrappers provided.
8180

8281
For metrics, decorate your handler with @signalfx_lambda.emits_metrics
8382

84-
::
83+
.. code:: python
8584
8685
import signalfx_lambda
8786
@@ -91,7 +90,7 @@ For metrics, decorate your handler with @signalfx_lambda.emits_metrics
9190
9291
For tracing, use the @signalfx_lambda.is_traced decorator
9392

94-
::
93+
.. code:: python
9594
9695
import signalfx_lambda
9796
@@ -207,7 +206,7 @@ The tracing wrapper creates a span for the wrapper handler. This span has the fo
207206
Sending custom metric from the Lambda function
208207
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
209208

210-
::
209+
.. code:: python
211210
212211
import signalfx_lambda
213212
@@ -223,7 +222,7 @@ Adding manual tracing to the Lambda function
223222
Manual instrumentation can be added to trace critical parts of your handler
224223
function.
225224

226-
::
225+
.. code:: python
227226
228227
import opentracing
229228
@@ -245,18 +244,18 @@ Testing it out locally
245244

246245
Use python-lambda-local
247246

248-
::
247+
.. code::
249248
250249
pip install python-lambda-local
251250
252-
::
251+
.. code::
253252
254253
python-lambda-local tests/test.py tests/event.json -a 'arn:aws:lambda:us-east-1:accountId:function:functionNamePython:$LATEST'
255254
256255
Packaging
257256
~~~~~~~~~
258257

259-
::
258+
.. code::
260259
261260
python setup.py bdist_wheel --universal
262261

0 commit comments

Comments
 (0)