Update custom-proxy.md #4243
Update custom-proxy.md #4243
Conversation
|
Thanks for putting this up. |
|
@silesky can you add your suggestions as suggestions to the file please? |
src/connections/sources/catalog/libraries/website/javascript/custom-proxy.md
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/website/javascript/custom-proxy.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/website/javascript/custom-proxy.md
Outdated
Show resolved
Hide resolved
src/connections/sources/catalog/libraries/website/javascript/custom-proxy.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Seth Silesky <5115498+silesky@users.noreply.github.com>
|
@silesky and @prigiattiperrut I edited the formatting of the doc a bit. Please let me know if these changes work |
| To proxy tracking calls that typically go to `api.segment.io/v1`, replace: | ||
| ```diff | ||
| - analytics.load("<MY_WRITE_KEY>") | ||
| + analytics.load("<MY_WRITE_KEY>", { integrations: { "Segment.io": { apiHost: "MY-CUSTOM-API-PROXY.com" }}}) |
There was a problem hiding this comment.
cc @pooyaj, @chrisradek -- IIRC, we have a place in the UI where we also allow apiHost to be overridden for custom domain customers -- if so, the "apiHost" configuration here is not necessary?
Should we leave a note about this?
There was a problem hiding this comment.
It looks like according to @pooyaj we actually want to nudge customers towards using the UI for updating apiHost.
Choices. Should we:
- publish these docs 'as is'
- wait until we've removed the feature flag, and then update the docs to use the
apiHostUI.
for example, we had cases where we want to figure out “which sources of a given customer use proxy to send data rather than directly through the tracking API” … it is really difficult to figure that out if they hard code api host in their snippet, but if they set it through the App it will be an easy query to find out.
There was a problem hiding this comment.
Hmm! Sorry, I will have to ask a few questions in return, just to clarify:
- How often do we need to figure out which sources are proxying Segment?
- Do we have an ETA for when the apiHost UI will be available to all customers by default?
I think if the answer to #1 is not very often and #2 we don't have an ETA, it will take some time, then I believe that we could still make this information available to customers as they will benefit from knowing it.
There was a problem hiding this comment.
How often do we need to figure out which sources are proxying Segment?
That's a question for @pooyaj -- but it's more of a nice to have
Do we have an ETA for when the apiHost UI will be available to all customers by default?
I have no idea -- that's not my team =) I was hoping you knew who was in charge (or if it's up to us to make the PR)
I think if the answer is not very often and we don't have an ETA, it will take some time, then I believe that we could still make this information available to customers as they will benefit from knowing it.
Agree, we should make the docs update with the information we have! Especially since there's some big restrictions to in-domain
There was a problem hiding this comment.
I agree we should push the update rather than wait for the UI.
src/connections/sources/catalog/libraries/website/javascript/custom-proxy.md
Show resolved
Hide resolved
|
@prigiattiperrut I just realized since maybe most people are snippet users, I think it would make sense to switch the order of the snippet instructions and the npm library instructions -- lest that be confusing =) |
…ustom-proxy.md Co-authored-by: Seth Silesky <5115498+silesky@users.noreply.github.com>
|
@silesky I moved the snippet users to the top. Is it good to go now? |
|
Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site. |
Add information from the README file to the public docs https://github.com/segmentio/analytics-next/pull/793/files