DDSaaS: Shopify: Crawler Integration v1.0.0 #18692

akaila-crest · 2024-09-27T13:57:29Z

What does this PR do?

This is an initial release PR of Shopify integration including all the required assets.

Additional Notes

Crawler code for this integration has been committed in its respective repo
Pipeline created for this integration are available in our sandbox and would be shared separately with the required teams.
Samples for the pipeline review would also be shared separately with the required teams.
Since during the standard attribute remapping we are not preserving the source attributes as per suggested best practices, it would result in filters using these standard attributes populating the values of other integrations as well as per current Datadog behavior.

Review checklist (to be filled by reviewers)

Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
Changelog entries must be created for modifications to shipped code
Add the qa/skip-qa label if the PR doesn't need to be tested during QA.
If you need to backport this PR to another branch, you can add the backport/<branch-name> label to the PR and it will automatically open a backport PR once this one is merged

cmlaverdiere · 2024-11-18T10:18:04Z

@akaila-crest Is this ready for review? If so please remove the PR from draft status. Also please resolve codeowners conflict.

akaila-crest · 2024-11-18T10:59:07Z

@cmlaverdiere, I have resolved the conflict, and yes PR is ready for the review.

estherk15

Left an initial review for documentation, let me know if you have any questions!

estherk15 · 2024-11-21T17:06:32Z

shopify/README.md

+
+[Shopify][1] is a comprehensive commerce platform designed to help individuals start, manage, and grow their businesses. It provides tools to build an online store, manage sales, market to customers, and accept payments in both digital and physical locations.
+
+The Shopify Integration collects Event, Product, Customer and Order logs, sending them to Datadog for detailed analysis.


Is "Customer and Order" one type of log or two separate types?

Suggested change

The Shopify Integration collects Event, Product, Customer and Order logs, sending them to Datadog for detailed analysis.

The Shopify Integration collects Event, Product, Customer, and Order logs, sending them to Datadog for detailed analysis.

Hi @estherk15,
Customer and Order are 2 separate log types.

estherk15 · 2024-11-21T17:11:06Z

shopify/README.md

+1. Log in to [Shopify][2] admin account 
+2. Shopify Store name is the `xxxx` part of the Store URL (`https://admin.shopify.com/store/xxxx`)
+3. Navigate to **Settings > Apps and sales channels**.


Suggested change

1. Log in to [Shopify][2] admin account

2. Shopify Store name is the `xxxx` part of the Store URL (`https://admin.shopify.com/store/xxxx`)

3. Navigate to **Settings > Apps and sales channels**.

1. Log in to [Shopify][2] admin account.

2. The Shopify Store name is the `xxxx` part of the Store URL (`https://admin.shopify.com/store/xxxx`).

3. Navigate to **Settings > Apps and sales channels**.

estherk15 · 2024-11-21T17:11:29Z

shopify/README.md

+1. Log in to [Shopify][2] admin account 
+2. Shopify Store name is the `xxxx` part of the Store URL (`https://admin.shopify.com/store/xxxx`)
+3. Navigate to **Settings > Apps and sales channels**.
+4. Select **Develop apps** and Click **Allow custom app development**.


Suggested change

4. Select **Develop apps** and Click **Allow custom app development**.

4. Select **Develop apps** and click **Allow custom app development**.

estherk15 · 2024-11-21T17:12:46Z

shopify/README.md

+2. Shopify Store name is the `xxxx` part of the Store URL (`https://admin.shopify.com/store/xxxx`)
+3. Navigate to **Settings > Apps and sales channels**.
+4. Select **Develop apps** and Click **Allow custom app development**.
+5. Click **Create a custom app**, provide the necessary details and Click on **Create app**.


Suggested change

5. Click **Create a custom app**, provide the necessary details and Click on **Create app**.

5. Click **Create a custom app**, provide the necessary details and click **Create app**.

estherk15 · 2024-11-21T17:23:05Z

shopify/README.md

+    - **read_customers** 
+    - **read_content** 
+    - **read_price_rules** 
+8. Click on **Save** to apply the changes.


Suggested change

8. Click on **Save** to apply the changes.

8. Click **Save** to apply the changes.

estherk15 · 2024-11-21T18:01:07Z

shopify/assets/dashboards/shopify_order_overview.json

+            "id": 8602455036825926,
+            "definition": {
+                "type": "note",
+                "content": "\n**[Shopify](https://www.shopify.com/)** is a comprehensive commerce platform that help individuals to start, manage, and grow a business. It offers a  set of tools to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.\n\nThe **Shopify Orders Overview** Dashboard provides an overview of orders within your store. It provides insights into order tracking, fulfillments, customers and product details.\n\nFor more information, see the [Shopify Integration Documentation](https://docs.datadoghq.com/integrations/shopify/).\n\n### Tip:-\n- Clone this dashboard to rearrange, modify and add widgets and visualizations.\n",


Suggested change

"content": "\n**[Shopify](https://www.shopify.com/)** is a comprehensive commerce platform that help individuals to start, manage, and grow a business. It offers a set of tools to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.\n\nThe **Shopify Orders Overview** Dashboard provides an overview of orders within your store. It provides insights into order tracking, fulfillments, customers and product details.\n\nFor more information, see the [Shopify Integration Documentation](https://docs.datadoghq.com/integrations/shopify/).\n\n### Tip:-\n- Clone this dashboard to rearrange, modify and add widgets and visualizations.\n",

"content": "\n**[Shopify](https://www.shopify.com/)** is a comprehensive commerce platform that helps individuals to start, manage, and grow a business. It offers a set of tools to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.\n\nThe **Shopify Orders Overview** Dashboard provides an overview of orders within your store. It provides insights into order tracking, fulfillments, customers and product details.\n\nFor more information, see the [Shopify Integration Documentation](https://docs.datadoghq.com/integrations/shopify/).\n\n### Tip:-\n- Clone this dashboard to rearrange, modify, and add widgets and visualizations.\n",

estherk15 · 2024-11-21T18:02:26Z

shopify/assets/dashboards/shopify_product_overview.json

+            "id": 1767411351951850,
+            "definition": {
+                "type": "note",
+                "content": "**[Shopify](https://www.shopify.com/)** is a comprehensive commerce platform that help individuals to start, manage, and grow a business. It offers a  set of tools to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.\n\nThe **Shopify Product Overview** Dashboard provides an overview of products within your store. It provides  insights into product types, status distribution, inventory and variant details.\n\nFor more information, see the [Shopify Integration Documentation](https://docs.datadoghq.com/integrations/shopify/).\n\n### Tip:-\n- Clone this dashboard to rearrange, modify and add widgets and visualizations.\n",


Suggested change

"content": "**[Shopify](https://www.shopify.com/)** is a comprehensive commerce platform that help individuals to start, manage, and grow a business. It offers a set of tools to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.\n\nThe **Shopify Product Overview** Dashboard provides an overview of products within your store. It provides insights into product types, status distribution, inventory and variant details.\n\nFor more information, see the [Shopify Integration Documentation](https://docs.datadoghq.com/integrations/shopify/).\n\n### Tip:-\n- Clone this dashboard to rearrange, modify and add widgets and visualizations.\n",

"content": "**[Shopify](https://www.shopify.com/)** is a comprehensive commerce platform that helps individuals to start, manage, and grow a business. It offers a set of tools to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.\n\nThe **Shopify Product Overview** Dashboard provides an overview of products within your store. It provides insights into product types, status distribution, inventory and variant details.\n\nFor more information, see the [Shopify Integration Documentation](https://docs.datadoghq.com/integrations/shopify/).\n\n### Tip:-\n- Clone this dashboard to rearrange, modify, and add widgets and visualizations.\n",

estherk15 · 2024-11-21T18:07:12Z

shopify/assets/monitors/order_cancellation_rate.json

+	"created_at": "2024-10-01",
+	"last_updated_at": "2024-10-01",
+	"title": "Order Cancellation Rate is High",
+	"description": "High order cancellation rate is monitored.",


Can you add more context, following the best practices guide:

This is not a copy of the title.

Define the problem stated by the title.

Answer why this is an issue worth alerting on.

Describe the impact of the problem.

estherk15 · 2024-11-21T18:08:36Z

shopify/assets/monitors/product_inventory_out_of_stock.json

+	"created_at": "2024-10-01",
+	"last_updated_at": "2024-10-01",
+	"title": "Product Inventory is Out of Stock",
+	"description": "Out of stock product inventory is monitored.",


Can you add more context, following the best practices guide:

This is not a copy of the title.

Define the problem stated by the title.

Answer why this is an issue worth alerting on.

Describe the impact of the problem.

estherk15 · 2024-11-21T18:09:33Z

shopify/manifest.json

+  "manifest_version": "2.0.0",
+  "app_uuid": "81c0f478-e722-454a-83d3-5e3f45e11ca8",
+  "app_id": "shopify",
+  "display_on_public_website": false,


To confirm, the docs are only available in the integration tile and not on the public documentation site.

ashah-crest added 5 commits September 23, 2024 19:31

Shopify Crawler integration without Assets

a23f74b

Checking CI failures

afe65a9

Checking CI failures

1da51fc

Resolving CI failures

2c665e4

Shopify Crawler integration with assets

c8e5a62

datadog-agent-integrations-bot bot added documentation changelog/no-changelog dev/testing dev/tooling qa/skip-qa Automatically skip this PR for the next QA labels Sep 27, 2024

ashah-crest added 3 commits September 27, 2024 20:00

Updated log pipeline

e723962

Added sample log result

4d0c6ba

Update log pipeline

6c1d35d

datadog-assets bot added docs/review-requested ecosystems/review-requested product/review-requested labels Sep 30, 2024

ashah-crest added 7 commits October 4, 2024 12:04

Merge branch 'master' into shopify-v1.0.0

bdd3658

Updated source_type_id to 622

50d1921

Merge branch 'shopify-v1.0.0' into shopify-assets-v1.0.0

643c5f0

Updated dashboard, monitors and images

58838fd

Merge branch 'master' into shopify-v1.0.0

9fb273e

Merge branch 'master' into shopify-v1.0.0

8167130

Merge branch 'shopify-v1.0.0' into shopify-assets-v1.0.0

86cb894

dj0well added the crest/asset-pr label Oct 13, 2024

ashah-crest added 4 commits November 7, 2024 12:10

Merge branch 'master' into shopify-v1.0.0

4951ce8

formatted CODEOWNERS

e512d6a

Merge branch 'shopify-v1.0.0' into shopify-assets-v1.0.0

604cc54

updated README steps and monitor names

354e913

cmlaverdiere previously approved these changes Nov 18, 2024

View reviewed changes

akaila-crest added 2 commits November 18, 2024 16:13

Merge branch 'master' into shopify-assets-v1.0.0

e2b6624

Update CODEOWNERS

d484771

akaila-crest marked this pull request as ready for review November 18, 2024 10:54

akaila-crest requested review from a team as code owners November 18, 2024 10:54

akaila-crest requested a review from cmlaverdiere November 18, 2024 10:59

hestonhoffman added the editorial review Waiting on a more in-depth review from a docs team editor label Nov 18, 2024

cmlaverdiere approved these changes Nov 19, 2024

View reviewed changes

Merge branch 'master' into shopify-assets-v1.0.0

437eb85

datadog-agent-integrations-bot bot added team/agent-integrations team/documentation team/logs-backend team/siem-logs-reviewers labels Nov 21, 2024

estherk15 reviewed Nov 21, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DDSaaS: Shopify: Crawler Integration v1.0.0 #18692

DDSaaS: Shopify: Crawler Integration v1.0.0 #18692

akaila-crest commented Sep 27, 2024

cmlaverdiere commented Nov 18, 2024 •

edited

Loading

akaila-crest commented Nov 18, 2024

estherk15 left a comment

estherk15 Nov 21, 2024

ashah-crest Nov 22, 2024

estherk15 Nov 21, 2024

estherk15 Nov 21, 2024

estherk15 Nov 21, 2024

estherk15 Nov 21, 2024

estherk15 Nov 21, 2024

estherk15 Nov 21, 2024

estherk15 Nov 21, 2024

estherk15 Nov 21, 2024

estherk15 Nov 21, 2024


		[Shopify][1] is a comprehensive commerce platform designed to help individuals start, manage, and grow their businesses. It provides tools to build an online store, manage sales, market to customers, and accept payments in both digital and physical locations.

		The Shopify Integration collects Event, Product, Customer and Order logs, sending them to Datadog for detailed analysis.

	4. Select Develop apps and Click Allow custom app development.
	4. Select Develop apps and click Allow custom app development.

	5. Click Create a custom app, provide the necessary details and Click on Create app.
	5. Click Create a custom app, provide the necessary details and click Create app.

	8. Click on Save to apply the changes.
	8. Click Save to apply the changes.

DDSaaS: Shopify: Crawler Integration v1.0.0 #18692

Are you sure you want to change the base?

DDSaaS: Shopify: Crawler Integration v1.0.0 #18692

Conversation

akaila-crest commented Sep 27, 2024

What does this PR do?

Additional Notes

Review checklist (to be filled by reviewers)

cmlaverdiere commented Nov 18, 2024 • edited Loading

akaila-crest commented Nov 18, 2024

estherk15 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cmlaverdiere commented Nov 18, 2024 •

edited

Loading