Integrate source performance harness with datadog #31410

xiaohansong · 2023-10-13T23:16:18Z

What

Integrate performance harness with datadog. This will send out a metric report after the run to datadog and datadog could collect them as a metric. Example:

https://app.datadoghq.com/metric/explorer?start=1697235297143&end=1697238897143&paused=false#N4Ig7glgJg5gpgFxALlAGwIYE8D2BXJVEADxQEYAaELcqyKBAC1pEbghkcLIF8qo4AMwgA7CAgg4RKUAiwAHOChASAtnADOcAE4RNIKtrgBHPJoQaUAbVBGN8qVoD6gnNtUZCKiOq279VKY6epbINiAiGOrKQdpYZAYgUJ4YThr42gDGSsgg6gi6mZaBZnHKGABuMMiZUiJwmQhuGgB0itqu7hgi2S1M2vic8gTAAFQ8IDwAulSdqniYoeFzCxgxpfGTMyAacmg5oPIY+wgIOUk4ME6ZixoQmYloonBOcorK6U9Qj89O9EzKERuDxoSb8CD2TBYV4Kc5PepbHh8HbyJ4IADCUmEMBQIgWaB4QA

How

Use Datadog Client to send a HTTP request with corresponding DD_API_KEY, which is stored as a secret in airbyte. I asked @git-phu to enable that secret for this repo so we would be able to reuse that.

Change k8s env and related command in GHA workflow so we can pass along these env variables.

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user?

For connector PRs, use this section to explain which type of semantic versioning bump occurs as a result of the changes. Refer to our Semantic Versioning for Connectors guidelines for more information. Breaking changes to connectors must be documented by an Airbyte engineer (PR author, or reviewer for community PRs) by using the Breaking Change Release Playbook.

If there are breaking changes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

Pre-merge Actions

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

Community member? Grant edit access to maintainers (instructions)
Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
Connector version is set to 0.0.1
- Dockerfile has version 0.0.1
Documentation updated
- Connector's README.md
- Connector's bootstrap.md. See description and examples
- docs/integrations/<source or destination>/<name>.md including changelog with an entry for the initial version. See changelog example
- docs/integrations/README.md

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.

Updating a connector

Community member or Airbyter

Grant edit access to maintainers (instructions)
Unit & integration tests added

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.

Connector Generator

Issue acceptance criteria met
PR name follows PR naming conventions
If adding a new generator, add it to the list of scaffold modules being tested
The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:generateScaffolds then checking in your changes
Documentation which references the generator is updated as needed

Updating the Python CDK

Airbyter

Before merging:

Pull Request description explains what problem it is solving
Code change is unit tested
Build and my-py check pass
Smoke test the change on at least one affected connector
- On Github: Run this workflow, passing --use-local-cdk --name=source-<connector> as options
- Locally: airbyte-ci connectors --use-local-cdk --name=source-<connector> test
PR is reviewed and approved

After merging:

Publish the CDK
- The CDK does not follow proper semantic versioning. Choose minor if this the change has significant user impact or is a breaking change. Choose patch otherwise.
- Write a thoughtful changelog message so we know what was updated.
Merge the platform PR that was auto-created for updating the Connector Builder's CDK version
- This step is optional if the change does not affect the connector builder or declarative connectors.

vercel · 2023-10-13T23:16:25Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
airbyte-docs	⬜️ Ignored (Inspect)	Visit Preview		Oct 16, 2023 10:51pm

git-phu · 2023-10-13T23:25:25Z

.github/workflows/connector-performance-command.yml

@@ -180,6 +180,7 @@ jobs:
          export STREAM_NUMBER=$STREAM_NUMBER
          export SYNC_MODE=$SYNC_MODE
          export HARNESS=$HARNESS_TYPE
+          export DD_API_KEY=${{ secrets.DD_API_KEY }}


You can set this env var in the env: section of this step

git-phu · 2023-10-14T00:14:25Z

.github/workflows/connector-performance-command.yml

@@ -180,6 +181,7 @@ jobs:
          export STREAM_NUMBER=$STREAM_NUMBER
          export SYNC_MODE=$SYNC_MODE
          export HARNESS=$HARNESS_TYPE
+          export DD_API_KEY=$DD_API_KEY


Maybe I'm missing something here, but why do we need to export like this when the env var is already set?

I’m following the comment on line 178 - seems we need to export those to be accessible to envsubst- though I haven’t tested if that comment is true in this case

~~you are right - that comment wasn't true. Fixed and cleaned it up.~~
I tested it on the wrong commit... rerunning the action

and it still works! https://github.com/airbytehq/airbyte/actions/runs/6540161486/job/17759616382 so you are right, we don't need to re-export stuff that has already been set in env.

git push

rodireich · 2023-10-17T16:39:10Z

...source-harness/src/main/java/io/airbyte/integrations/source_performance/PerformanceTest.java

+        new MetricResource().name("github").type("runner"),
+        new MetricResource().name(imageName).type("image"),
+        new MetricResource().name(dataset).type("dataset"));
+    MetricPayload body =


Co-authored-by: xiaohansong <[email protected]>

xiaohansong and others added 30 commits October 11, 2023 11:20

empty line to create a PR

7e185e1

Automated Commit - Formatting Changes

9023148

attempt a fix

f167679

typo

dfc9c67

add logs

8542cac

try adding path directly

21cabaa

whoami?

86b6ca9

export path in write part

406da8b

add secrets

9dd5c7c

try different way to create cred

3d98ddd

Merge remote-tracking branch 'origin/master' into xiaohan/harness-fix

0fb5fef

remove unnecessary printout

ba4f4f3

make comment optional

6a97539

Merge branch 'master' into xiaohan/harness-fix

4d42500

update postgres catalog

0adb090

Automated Commit - Formatting Changes

c4a2bd3

Merge branch 'master' into xiaohan/harness-fix

1ed2779

add more logs, suspecting it's not reading from the latest catalog

86f5f05

more logs

bd758f3

remove gitref

637a9df

need to check local branch and master branch to do git diff

2ab9f44

remove origin

59eb0be

need to fetch all in perf-test step

a08ad54

add back ref

daa81f2

remove logs

4d07a76

Merge branch 'master' into xiaohan/harness-fix

ceade6d

formatting

beee3ee

datadog test

5d7fc32

insert real datadog metrics

e0a6dc2

Merge remote-tracking branch 'origin/master' into xiaohan/datadog-perf

f06d2e0

xiaohansong requested review from rodireich and git-phu October 13, 2023 23:16

git-phu reviewed Oct 13, 2023

View reviewed changes

xiaohansong and others added 2 commits October 13, 2023 23:31

Automated Commit - Formatting Changes

2176e08

format and env

04a1d97

git-phu reviewed Oct 14, 2023

View reviewed changes

Merge branch 'master' into xiaohan/datadog-perf

1d52f3f

vercel bot deployed to Preview October 16, 2023 21:58 View deployment

xiaohansong added 5 commits October 16, 2023 15:01

test without export envsubst would still work or not

e0d46d6

export changed names only:

5888e9a

git push

revert

dcc7d8f

one more try

c0a2686

updated comment

f04d291

rodireich reviewed Oct 17, 2023

View reviewed changes

rodireich approved these changes Oct 17, 2023

View reviewed changes

xiaohansong merged commit a946a38 into master Oct 17, 2023
21 checks passed

xiaohansong deleted the xiaohan/datadog-perf branch October 17, 2023 16:57

ariesgun pushed a commit to ariesgun/airbyte that referenced this pull request Oct 23, 2023

Integrate source performance harness with datadog (airbytehq#31410)

62bb25b

Co-authored-by: xiaohansong <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Integrate source performance harness with datadog #31410

Integrate source performance harness with datadog #31410

xiaohansong commented Oct 13, 2023

vercel bot commented Oct 13, 2023 •

edited

Loading

git-phu Oct 13, 2023

git-phu Oct 14, 2023

xiaohansong Oct 14, 2023

xiaohansong Oct 16, 2023 •

edited

Loading

xiaohansong Oct 16, 2023

rodireich Oct 17, 2023

Integrate source performance harness with datadog #31410

Integrate source performance harness with datadog #31410

Conversation

xiaohansong commented Oct 13, 2023

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Actions

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Airbyter

vercel bot commented Oct 13, 2023 • edited Loading

git-phu Oct 13, 2023

Choose a reason for hiding this comment

git-phu Oct 14, 2023

Choose a reason for hiding this comment

xiaohansong Oct 14, 2023

Choose a reason for hiding this comment

xiaohansong Oct 16, 2023 • edited Loading

Choose a reason for hiding this comment

xiaohansong Oct 16, 2023

Choose a reason for hiding this comment

rodireich Oct 17, 2023

Choose a reason for hiding this comment

vercel bot commented Oct 13, 2023 •

edited

Loading

xiaohansong Oct 16, 2023 •

edited

Loading