Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DDSaaS: Shopify: Crawler Integration v1.0.0 #18692

Open
wants to merge 22 commits into
base: master
Choose a base branch
from
Open

DDSaaS: Shopify: Crawler Integration v1.0.0 #18692

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
a23f74b
Shopify Crawler integration without Assets
ashah-crest Sep 23, 2024
afe65a9
Checking CI failures
ashah-crest Sep 24, 2024
1da51fc
Checking CI failures
ashah-crest Sep 24, 2024
2c665e4
Resolving CI failures
ashah-crest Sep 24, 2024
c8e5a62
Shopify Crawler integration with assets
ashah-crest Sep 27, 2024
e723962
Updated log pipeline
ashah-crest Sep 27, 2024
4d0c6ba
Added sample log result
ashah-crest Sep 27, 2024
6c1d35d
Update log pipeline
ashah-crest Sep 30, 2024
bdd3658
Merge branch 'master' into shopify-v1.0.0
ashah-crest Oct 4, 2024
50d1921
Updated source_type_id to 622
ashah-crest Oct 4, 2024
643c5f0
Merge branch 'shopify-v1.0.0' into shopify-assets-v1.0.0
ashah-crest Oct 4, 2024
58838fd
Updated dashboard, monitors and images
ashah-crest Oct 4, 2024
9fb273e
Merge branch 'master' into shopify-v1.0.0
ashah-crest Oct 7, 2024
8167130
Merge branch 'master' into shopify-v1.0.0
ashah-crest Oct 11, 2024
86cb894
Merge branch 'shopify-v1.0.0' into shopify-assets-v1.0.0
ashah-crest Oct 11, 2024
4951ce8
Merge branch 'master' into shopify-v1.0.0
ashah-crest Nov 7, 2024
e512d6a
formatted CODEOWNERS
ashah-crest Nov 7, 2024
604cc54
Merge branch 'shopify-v1.0.0' into shopify-assets-v1.0.0
ashah-crest Nov 7, 2024
354e913
updated README steps and monitor names
ashah-crest Nov 7, 2024
e2b6624
Merge branch 'master' into shopify-assets-v1.0.0
akaila-crest Nov 18, 2024
d484771
Update CODEOWNERS
akaila-crest Nov 18, 2024
437eb85
Merge branch 'master' into shopify-assets-v1.0.0
akaila-crest Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/CODEOWNERS
View file
Open in desktop
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,11 @@ datadog_checks_base/datadog_checks/base/checks/windows/ @DataDog/wi
/trend_micro_vision_one_endpoint_security/manifest.json @DataDog/saas-integrations @DataDog/documentation
/trend_micro_vision_one_endpoint_security/assets/logs/ @DataDog/saas-integrations @DataDog/documentation @DataDog/logs-backend

/shopify/ @DataDog/saas-integrations
/shopify/*.md @DataDog/saas-integrations @DataDog/documentation
/shopify/manifest.json @DataDog/saas-integrations @DataDog/documentation
/shopify/assets/logs/ @DataDog/saas-integrations @DataDog/documentation @DataDog/logs-backend

/hubspot_content_hub/ @DataDog/saas-integrations
/hubspot_content_hub/*.md @DataDog/saas-integrations @DataDog/documentation
/hubspot_content_hub/manifest.json @DataDog/saas-integrations @DataDog/documentation
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/config/labeler.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,8 @@ integration/sap_hana:
- sap_hana/**/*
integration/scylla:
- scylla/**/*
integration/shopify:
- shopify/**/*
integration/sidekiq:
- sidekiq/**/*
integration/silk:
Expand Down
7 changes: 7 additions & 0 deletions shopify/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# CHANGELOG - shopify

## 1.0.0 / 2024-09-23

***Added***:

* Initial Release
60 changes: 60 additions & 0 deletions shopify/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Shopify

## Overview

[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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


It includes dashboards that show and analyze logs, making it easier to monitor and understand patterns.

## Setup

### Configuration

#### Get Shopify Credentials
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Get Shopify Credentials
#### Get Shopify credentials

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**.
Comment on lines +16 to +18
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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**.

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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**.

6. Click **Configure Admin API Scopes** under the Overview tab.
7. In the **Admin API access scopes section**, select the following scopes:
- **read_orders**
- **read_products**
- **read_customers**
- **read_content**
- **read_price_rules**
8. Click on **Save** to apply the changes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

9. Click on **Install app**.
10. Under the **Admin API access token** section, Click on **Reveal token once**.
Comment on lines +29 to +30
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
9. Click on **Install app**.
10. Under the **Admin API access token** section, Click on **Reveal token once**.
9. Click **Install app**.
10. Under the **Admin API access token** section, click **Reveal token once**.


#### Add Shopify Credentials
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will readers understand what this is referring to? Where do they add these credentials?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Add Shopify Credentials
#### Add Shopify credentials

- Shopify Store Name
- Shopify Access Token

## Data Collected

### Logs

The Shopify integration collects and forward Event, Product, Customer and Order logs to Datadog.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same question here about "Customer and Order".


### Metrics

The Shopify integration does not include any metrics.

### Service Checks

The Shopify integration does not include any service checks.

### Events

The Shopify integration does not include any events.

## Troubleshooting

Need help? Contact [Datadog support][3].

[1]: https://www.shopify.com/
[2]: https://www.shopify.com/in/store-login
[3]: https://docs.datadoghq.com/help/
Loading
Loading