Skip to content

Commit

Permalink
Embed Lambda library docs (DataDog#8359)
Browse files Browse the repository at this point in the history
* Refresh Lambda library docs

* Embed Lambda library READMEs

* Apply suggestions from code review

Co-authored-by: ruthnaebeck <19349244+ruthnaebeck@users.noreply.github.com>

Co-authored-by: ruthnaebeck <19349244+ruthnaebeck@users.noreply.github.com>
  • Loading branch information
tianchu and ruthnaebeck authored Aug 25, 2020
1 parent 40c254e commit b10a463
Show file tree
Hide file tree
Showing 8 changed files with 250 additions and 204 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,11 @@ content/en/real_user_monitoring/android.md

# serverless
content/en/serverless/forwarder.md
content/en/serverless/datadog_lambda_library/python.md
content/en/serverless/datadog_lambda_library/nodejs.md
content/en/serverless/datadog_lambda_library/ruby.md
content/en/serverless/datadog_lambda_library/go.md
content/en/serverless/datadog_lambda_library/java.md

# Runtime data
pids
Expand Down
2 changes: 1 addition & 1 deletion .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ build_live:
variables:
CONFIG: ${LIVE_CONFIG}
URL: ${LIVE_DOMAIN}
UNTRACKED_EXTRAS: "data,content/en/agent/basic_agent_usage/heroku.md,content/en/agent/basic_agent_usage/ansible.md,content/en/agent/basic_agent_usage/chef.md,content/en/agent/basic_agent_usage/puppet.md,content/en/developers/integrations,content/en/agent/basic_agent_usage/saltstack.md,content/en/developers/amazon_cloudformation.md,content/en/integrations,content/en/logs/log_collection/android.md,content/en/logs/log_collection/ios.md,content/en/tracing/setup/android.md,content/en/tracing/setup/ruby.md,content/en/security_monitoring/default_rules,content/en/serverless/forwarder.md,content/en/real_user_monitoring/android.md"
UNTRACKED_EXTRAS: "data,content/en/agent/basic_agent_usage/heroku.md,content/en/agent/basic_agent_usage/ansible.md,content/en/agent/basic_agent_usage/chef.md,content/en/agent/basic_agent_usage/puppet.md,content/en/developers/integrations,content/en/agent/basic_agent_usage/saltstack.md,content/en/developers/amazon_cloudformation.md,content/en/integrations,content/en/logs/log_collection/android.md,content/en/logs/log_collection/ios.md,content/en/tracing/setup/android.md,content/en/tracing/setup/ruby.md,content/en/security_monitoring/default_rules,content/en/serverless/forwarder.md,content/en/serverless/datadog_lambda_library/python.md,content/en/serverless/datadog_lambda_library/nodejs.md,content/en/serverless/datadog_lambda_library/ruby.md,content/en/serverless/datadog_lambda_library/go.md,content/en/serverless/datadog_lambda_library/java.md,content/en/real_user_monitoring/android.md"
CONFIGURATION_FILE: "./local/bin/py/build/configurations/pull_config.yaml"
LOCAL: "False"
script:
Expand Down
10 changes: 10 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,16 @@ clean-auto-doc: ##Remove all doc automatically created
rm -f content/en/agent/basic_agent_usage/saltstack.md ;fi
@if [ content/en/serverless/forwarder.md ]; then \
rm -f content/en/serverless/forwarder.md ;fi
@if [ content/en/serverless/datadog_lambda_library/python.md ]; then \
rm -f content/en/serverless/datadog_lambda_library/python.md ;fi
@if [ content/en/serverless/datadog_lambda_library/nodejs.md ]; then \
rm -f content/en/serverless/datadog_lambda_library/nodejs.md ;fi
@if [ content/en/serverless/datadog_lambda_library/ruby.md ]; then \
rm -f content/en/serverless/datadog_lambda_library/ruby.md ;fi
@if [ content/en/serverless/datadog_lambda_library/go.md ]; then \
rm -f content/en/serverless/datadog_lambda_library/go.md ;fi
@if [ content/en/serverless/datadog_lambda_library/java.md ]; then \
rm -f content/en/serverless/datadog_lambda_library/java.md ;fi
@if [ content/en/real_user_monitoring/android.md ]; then \
rm -f content/en/real_user_monitoring/android.md ;fi
@if [ content/en/tracing/setup/ruby.md ]; then \
Expand Down
52 changes: 40 additions & 12 deletions config/_default/menus/menus.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -558,10 +558,12 @@ main:
- name: Node.js
url: serverless/installation/nodejs
parent: serverless_installation
identifier: serverless_installation_nodejs
weight: 102
- name: Ruby
url: serverless/installation/ruby
parent: serverless_installation
identifier: serverless_installation_ruby
weight: 103
- name: Java
url: serverless/installation/java
Expand All @@ -579,48 +581,74 @@ main:
identifier: serverless_installation_dotnet
weight: 106
- name: Datadog Lambda Library
url: serverless/installation/installing_the_library
parent: serverless_installation
weight: 108
url: serverless/datadog_lambda_library
parent: serverless
identifier: serverless_datadog_lambda_library
weight: 2
- name: Python
url: serverless/datadog_lambda_library/python
parent: serverless_datadog_lambda_library
identifier: serverless_datadog_lambda_library_python
weight: 201
- name: Node.js
url: serverless/datadog_lambda_library/nodejs
parent: serverless_datadog_lambda_library
identifier: serverless_datadog_lambda_library_nodejs
weight: 202
- name: Ruby
url: serverless/datadog_lambda_library/ruby
parent: serverless_datadog_lambda_library
identifier: serverless_datadog_lambda_library_ruby
weight: 203
- name: Go
url: serverless/datadog_lambda_library/go
parent: serverless_datadog_lambda_library
identifier: serverless_datadog_lambda_library_go
weight: 204
- name: Java
url: serverless/datadog_lambda_library/java
parent: serverless_datadog_lambda_library
identifier: serverless_datadog_lambda_library_java
weight: 205
- name: Datadog Forwarder
url: serverless/forwarder
parent: serverless
weight: 2
weight: 3
- name: Enhanced Lambda Metrics
url: serverless/enhanced_lambda_metrics
parent: serverless
weight: 3
weight: 4
- name: Distributed Tracing
url: serverless/distributed_tracing
identifier: serverless_distributed_tracing
parent: serverless
weight: 4
weight: 5
- name: Enable AWS X-Ray
url: tracing/serverless_functions
parent: serverless_distributed_tracing
weight: 401
weight: 501
- name: Custom Metrics
url: serverless/custom_metrics
parent: serverless
weight: 5
weight: 6
- name: Serverless Integrations
url: serverless/serverless_integrations
parent: serverless
weight: 6
weight: 7
- name: Serverless Tagging
url: serverless/serverless_tagging
parent: serverless
weight: 7
weight: 8
- name: Troubleshooting
url: serverless/troubleshooting
parent: serverless
identifier: serverless_troubleshooting
weight: 8
weight: 9
- name: Azure App Services Extension
url: serverless/azure_app_services
parent: serverless
identifier: serverless_app_services
weight: 9
weight: 10
- name: Metrics
url: metrics/
identifier: metrics_top_level
Expand Down
54 changes: 54 additions & 0 deletions content/en/serverless/datadog_lambda_library/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Datadog Lambda Library
kind: documentation
further_reading:
- link: "/serverless/datadog_lambda_library/python"
tag: "Datadog Lambda Library for Python"
text: "Datadog Lambda Library for Python"
- link: "/serverless/datadog_lambda_library/nodejs"
tag: "Datadog Lambda Library for Node.js"
text: "Datadog Lambda Library for Node.js"
- link: "/serverless/datadog_lambda_library/ruby"
tag: "Datadog Lambda Library for Ruby"
text: "Datadog Lambda Library for Ruby"
- link: "/serverless/datadog_lambda_library/go"
tag: "Datadog Lambda Library for Go"
text: "Datadog Lambda Library for Go"
- link: "/serverless/datadog_lambda_library/java"
tag: "Datadog Lambda Library for Java"
text: "Datadog Lambda Library for Java"
---

{{< img src="serverless/datadog_lambda_library.png" alt="Datadog Lambda Library" style="width:100%;">}}

The Datadog Lambda Library is responsible for:

- Generating real-time [enhanced Lambda metrics][1] for invocations, errors, cold starts, estimated costs, etc.
- Submitting [custom metrics][2] (synchronously and asynchronously).
- Enabling [Datadog APM and Distributed Tracing][3] for Node.js, Python, and Ruby.

The Datadog Lambda Library is **NOT** responsible for collecting:

- Lambda metrics from CloudWatch (see [AWS Lambda Integration][4])
- Lambda traces from X-Ray (see [AWS X-Ray integration][5])
- Lambda logs from CloudWatch (see [Datadog Forwarder][6])

Datadog distributes the Lambda library as a package for Python, Node.js, Ruby, Go, and Java. Packages are installed through the common package managers, such as pip, npm, gem, maven, etc.

The Datadog Lambda library is also available as [Lambda layers][7] for Python, Node.js, and Ruby.

To install the Datadog Lambda library and instrument your serverless applications, see the [installation instructions][8].

## Further Reading

{{< partial name="whats-next/whats-next.html" >}}


[1]: /serverless/enhanced_lambda_metrics/
[2]: /serverless/custom_metrics/
[3]: /tracing/
[4]: /integrations/amazon_lambda/
[5]: /integrations/amazon_xray/
[6]: /serverless/forwarder/
[7]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html
[8]: /serverless/installation/
191 changes: 0 additions & 191 deletions content/en/serverless/installation/installing_the_library.md

This file was deleted.

Loading

0 comments on commit b10a463

Please sign in to comment.