DOCS-9587: restructure step functions install page #26825

cswatt · 2024-12-17T22:50:45Z

What does this PR do? What is the motivation?

work in progress

Merge instructions

Merge readiness:

Ready for merge

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

Additional notes

github-actions · 2024-12-17T22:53:42Z

Preview links (active after the `build_preview` check completes)

New or renamed files

https://docs-staging.datadoghq.com/cswatt/sfn-updates/serverless/guide/step_functions_cdk

Modified Files

lym953

Thanks for improving the doc!

lym953 · 2024-12-18T21:17:30Z

content/en/serverless/step_functions/installation.md

+
+    For more information about the `datadog-ci stepfunctions` command, see the [Datadog CLI documentation][4].
+
+1. Set up tags. Open your AWS console and go to your Step Functions state machine. Open the *Tags* section and add the following key-value pairs:


I don't think this manual step is needed. datadog-ci command will add these tags. Is this section copied from somewhere?

lym953 · 2024-12-18T21:19:42Z

content/en/serverless/step_functions/installation.md

+   | `dd_version` | `dd_sls_plugin`| 
+
+1. To enable tracing, you have two options:
+   - **Per Step Function**: Add the `DD_TRACE_ENABLED` tag to each Step Function and set the value to `true`.


We can add something like: The datadog-ci stepfunctions instrument command already does this, so no extra work is needed.

lym953 · 2024-12-18T21:21:44Z

content/en/serverless/step_functions/installation.md

+
+    For additional settings, see [Datadog Serverless Framework Plugin - Configuration parameters][5].
+
+1. Set up tags. Open your AWS console and go to your Step Functions state machine. Open the *Tags* section and add the following key-value pairs:


This is not needed. Serverless Plugin will set these tags.

lym953 · 2024-12-18T21:22:34Z

content/en/serverless/step_functions/installation.md

+   | `dd_version` | `dd_sls_ci`| 
+
+1. To enable tracing, you have two options:
+   - **Per Step Function**: Add the `DD_TRACE_ENABLED` tag to each Step Function and set the value to `true`.


We only need to add enableStepFunctionsTracing: true, as shown in the example code above.

lym953 · 2024-12-18T21:24:35Z

content/en/serverless/step_functions/installation.md

+   ```
+   /aws/vendedlogs/states/<CDK_PATH>-Logs
+   ```
+
+   **Optionally**, you can add your environment to this log group name: `/aws/vendedlogs/states/<CDK_PATH>-Logs-<ENV>`


With CDK, the user won't need to create the log group on their own.
Also, the instructions for CDK are incomplete. Is there a plan to write this part in a separate PR?

jeastham1993 · 2025-02-12T19:05:49Z

content/en/serverless/guide/step_functions_cdk.md

+
+[1]: https://github.com/DataDog/datadog-cdk-constructs/tree/main/examples/step-functions-python-stack
+{{% /tab %}}
+{{% tab "Go" %}}


Just a question, but do we only have the official CDK constructs available in Go, TS and Python? And no support for .NET/Java right?

That's right. I added Go in August 2024. Let me know if there's a need to support .NET or Java.

.NET & Java definitely aren't as widely used, I'm just thinking for completeness that's all. So we can say we support all runtimes.

Is there not a way with the CDK to write it once in Javascript and then auto-gen the other runtimes though?

This is a CDK construct for defining .NET Lambda functions. The construct is defined once in Typescript and then uses Projen to generate all the other packages. Could we not do the same for our constructs?

https://github.com/cdklabs/awscdk-lambda-dotnet/blob/main/.github/workflows/release.yml

Yes, I think it's 1–2 week one-time work to support a new language.
From what I understand, we often use a "lazy" approach that we don't build something until some customer asks for it. Have you heard of any customer ask, or could you align with Sumedha on this?

jeastham1993 · 2025-02-12T19:08:33Z

I like the write-up, some more general added separately to make the conversation easier :)

Do we want to add an example in Terraform as well? Maybe not so useful for serverless app developers, but I've seen a lot of usage of StepFunctions for infra/platform level tasks (account provisioning etc). Ancedotally, folks doing those kind of tasks may want to use Terraform. I've got TF examples in my serverless sample app and you'd only need one to cover all runtimes

jeastham1993 · 2025-02-12T19:11:22Z

I think we should add some content on how a .NET or Java developer would do this. Even if we don't have the Datadog SFN CDK construct it would be good to get specific to show a .NET/Java developer how they would do it in the CDK. Again I have examples in my sample app repo if you want me to share.

jeastham1993 · 2025-02-12T19:11:44Z

I don't see anything about AWS SAM, but it might be that SAM is already in the docs and not relevant for this PR.

lym953

Otherwise LGTM! I like this new structure.

lym953 · 2025-02-12T20:00:50Z

content/en/serverless/guide/step_functions_cdk.md

+  jsii.String("DatadogSfn"),
+  &ddcdkconstruct.DatadogStepFunctionsProps{
+    Env:            jsii.String("<ENV>"), // e.g. "dev"
+    Service:        jsii.String("<SERVICE>), // e.g. "my-cdk-service"


"<SERVICE>" misses a quote. Could you correct it here? Sorry I missed it in the original README.

lym953 · 2025-02-12T20:06:24Z

content/en/serverless/step_functions/installation.md

+
+   Take note of your Forwarder's ARN.
+
+1. Add the following to your `serverless.yml`:


I think this should be something like

Run the following command:

or just

Run:

Only the Serverless Plugin approach has serverless.yml.

whoops, copy/paste error. correcting

lym953 · 2025-02-12T20:12:49Z

I think we should add some content on how a .NET or Java developer would do this. Even if we don't have the Datadog SFN CDK construct it would be good to get specific to show a .NET/Java developer how they would do it in the CDK.

I don't know a good way for a .NET/Java developer. I think we can add something like:

If you want our CDK library to be available in .NET or Java, please open an issue in https://github.com/DataDog/datadog-cdk-constructs/issues so we can hear you and support it.

initial commit

23aafeb

cswatt added the WORK IN PROGRESS No review needed, it's a wip ;) label Dec 17, 2024

cswatt requested review from a team as code owners December 17, 2024 22:50

lym953 reviewed Dec 18, 2024

View reviewed changes

updating

b6e5031

cswatt requested a review from a team as a code owner January 28, 2025 20:12

cswatt added 2 commits January 28, 2025 12:13

Merge branch 'master' into cswatt/sfn-updates

5ec964f

more updates

bfd6259

github-actions bot added the Guide Content impacting a guide label Jan 28, 2025

jeastham1993 reviewed Feb 12, 2025

View reviewed changes

lym953 reviewed Feb 12, 2025

View reviewed changes

some updates

7706f5f

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCS-9587: restructure step functions install page #26825

DOCS-9587: restructure step functions install page #26825

cswatt commented Dec 17, 2024

github-actions bot commented Dec 17, 2024 •

edited

Loading

lym953 left a comment

lym953 Dec 18, 2024

lym953 Dec 18, 2024

lym953 Dec 18, 2024

lym953 Dec 18, 2024

lym953 Dec 18, 2024

jeastham1993 Feb 12, 2025

lym953 Feb 12, 2025

jeastham1993 Feb 12, 2025

jeastham1993 Feb 12, 2025

lym953 Feb 12, 2025 •

edited

Loading

jeastham1993 commented Feb 12, 2025 •

edited

Loading

jeastham1993 commented Feb 12, 2025

jeastham1993 commented Feb 12, 2025

lym953 left a comment

lym953 Feb 12, 2025

lym953 Feb 12, 2025

cswatt Feb 12, 2025

lym953 commented Feb 12, 2025


		For more information about the `datadog-ci stepfunctions` command, see the [Datadog CLI documentation][4].

		1. Set up tags. Open your AWS console and go to your Step Functions state machine. Open the Tags section and add the following key-value pairs:


		For additional settings, see [Datadog Serverless Framework Plugin - Configuration parameters][5].

		1. Set up tags. Open your AWS console and go to your Step Functions state machine. Open the Tags section and add the following key-value pairs:


		Take note of your Forwarder's ARN.

		1. Add the following to your `serverless.yml`:

DOCS-9587: restructure step functions install page #26825

Are you sure you want to change the base?

DOCS-9587: restructure step functions install page #26825

Conversation

cswatt commented Dec 17, 2024

What does this PR do? What is the motivation?

Merge instructions

Additional notes

github-actions bot commented Dec 17, 2024 • edited Loading

Preview links (active after the build_preview check completes)

New or renamed files

Modified Files

lym953 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lym953 Feb 12, 2025 • edited Loading

Choose a reason for hiding this comment

jeastham1993 commented Feb 12, 2025 • edited Loading

jeastham1993 commented Feb 12, 2025

jeastham1993 commented Feb 12, 2025

lym953 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lym953 commented Feb 12, 2025

github-actions bot commented Dec 17, 2024 •

edited

Loading

Preview links (active after the `build_preview` check completes)

lym953 Feb 12, 2025 •

edited

Loading

jeastham1993 commented Feb 12, 2025 •

edited

Loading