Skip to content

Destination Functions: Document error types #677

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.

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

Merged
merged 7 commits into from
Mar 4, 2020
Merged

Conversation

tysonmote
Copy link
Contributor

Proposed changes

Destination Functions can return errors that are visible in Event Delivery but their meaning isn't clear (yet). I added documentation to clear that up.

Related issues (optional)

Fixes FUN-619: https://segment.atlassian.net/browse/FUN-619

### Errors That Are Retried

* "Internal": An error not thrown by your function code and not covered by any other error classification. This is most commonly caused by your function exceeding its time limit, which is 5 seconds by default.
* "Too Many Requests": Your Function is receiving too many events and is being throttled. If this error persists for more than an hour, please email us at [friends@segment.com](mailto:friends@segment.com) for help.
Copy link
Contributor

Choose a reason for hiding this comment

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

We no longer give out this email alias in docs.

@sanscontext
Copy link
Contributor

Some style notes:

  • Please use sentence case for headings. In these, "Destination Functions" is a product name, which is why they're (yes I agree somewhat awkwardly) capitalized. (I'll make sure this gets added to the right part of the styleguide.
  • You can't add code-format to headings. I can't tell if this is a renderer backend issue or a css issue on our side, but it breaks heading links so let's undo that. :)

tysonmote and others added 4 commits March 3, 2020 12:33
Co-Authored-By: LRubin <sanscontext@users.noreply.github.com>
Co-Authored-By: LRubin <sanscontext@users.noreply.github.com>
Co-Authored-By: LRubin <sanscontext@users.noreply.github.com>
@tysonmote
Copy link
Contributor Author

@sanscontext Thanks! I think I may have looked at an old page to determine if we used titlecase or not. That's now fixed (I think).

@sanscontext
Copy link
Contributor

I don't think we've been consistent in the past, so no worries either way. Destination Function is still a product name technically and doesn't need to be decapped, but this is close enough. :)

@sanscontext sanscontext self-requested a review March 3, 2020 22:14
@sanscontext
Copy link
Contributor

Oh hey! is this at all useful to link to and from? https://segment.com/docs/connections/integration_error_codes/

@tysonmote
Copy link
Contributor Author

Those codes don't quite apply to Destination Functions. Thanks for the heads-up though!

@tysonmote tysonmote merged commit 128dc7c into master Mar 4, 2020
@tysonmote tysonmote deleted the dest-func-errors branch March 4, 2020 00:40
bot-docsteam added a commit that referenced this pull request Nov 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants