🐛 Source Instagram: change requested metrics for stream media_insights

[artem1205]

What

Resolve https://github.com/airbytehq/oncall/issues/3875

How

change requested metrics for stream media_insights

Old metric	New metric
carousel_album_engagement	total_interactions
carousel_album_impressions	impressions
carousel_album_reach	reach
carousel_album_saved	saved
carousel_album_video_views	video_views
engagement	total_interactions

See changelog and insight docs for more info

Recommended reading order

1. airbyte-integrations/connectors/source-instagram/source_instagram/streams.py

🚨 User Impact 🚨

no breaking changes

Pre-merge Actions

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.

[vercel]

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		Jan 3, 2024 4:30pm

[github-actions]

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

• PR name follows PR naming conventions
• Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan.
• Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
• You've updated the connector's metadata.yaml file any other relevant changes, including a breakingChanges entry for major version bumps. See metadata.yaml docs
• Secrets in the connector's spec are annotated with airbyte_secret
• All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
• Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
• Migration guide updated in docs/integrations/<source or destination>/<name>-migrations.md with an entry for the new version, if the version is a breaking change. See migration guide example
• If set, you've ensured the icon is present in the platform-internal repo. (Docs)

If the checklist is complete, but the CI check is failing,

1. Check for hidden checklists in your PR description

2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

[pedroslopez]

Thanks artem - I left a comment regarding one of the alternate metrics.

Also, does this require a schema refresh?

I think had we caught this on time this would have been a breaking change since customers need to adapt to use the new metrics on any downstream usages of the old metrics, but I'm currently on the fence since it's currently breaking in general, and releasing an immediately required breaking change would pause everyone's syncs (though maybe that's what we need). I'm hoping the answer to these questions helps make that decision.

[pedroslopez]

@artem1205 I see total_interactions is listed as an alternative, but the change log states this:

Note: total_interactions, which is listed as an alternative for some of the deprecated metrics, is currently only available using version 18.0 and does not work with older versions. When querying older versions before Dec 11, 2023, please use the engagement metric

This seems to imply total_interactions won't work for us since I believe we're on v11 - is this right?

[artem1205]

According to the docs, this should not work with v11, but it does (tested with customers creds).

[artem1205]

Thanks artem - I left a comment regarding one of the alternate metrics.

Also, does this require a schema refresh?

I think had we caught this on time this would have been a breaking change since customers need to adapt to use the new metrics on any downstream usages of the old metrics, but I'm currently on the fence since it's currently breaking in general, and releasing an immediately required breaking change would pause everyone's syncs (though maybe that's what we need). I'm hoping the answer to these questions helps make that decision.

@pedroslopez ,
It is not a breaking change from our perspective, as no fields are removed, new metrics are already presented in schema.