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.

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

Update package to 4.4 adding documentation for new client methods #105

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
## 4.4.0 (9/03/2022):
Features:
- Added set_tags method to client to allow globally scoped tags to be specified once rather than per exception
- Added set_customdata method to client to allow globally scoped custom data to be specified once rather than per exception

## 4.3.2 (24/02/2022):
Features:
- Added user_override method to send_exception to resolve an issue with specifying the user with concurrent connections

## 4.3.1 (5/11/2021):
Bugfixes
- Fix for a crash under Django ([#93](https://github.com/MindscapeHQ/raygun4py/issues/93))

## 4.3.0 (06/06/2019):
Features:
- Added a new config option, `transmit_environment_variables`, to control sending any environment variables at all
Expand Down
26 changes: 25 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,30 @@ Customer data can be passed in which will be displayed in the Raygun web app. Th

`identifier` should be whatever unique key you use to identify customers, for instance an email address. This will be used to create the count of affected customers. If you wish to anonymize it, you can generate and store a UUID or hash one or more of their unique login data fields, if available.

+----------------+---------------+--------------------+
| Function | Arguments | Type |
+================+===============+====================+
| set_tags | tags | List |
+----------------+---------------+--------------------+

A List of tags can be passed in which will be added to each exception that is raised. When this is used in conjunction with the tags argument on send_exception the set will be unioned with the argument to send_exception taking priority.

.. code:: python

client.set_tags(["tag1", "tag2"])

+----------------+--------------------+--------------------+
| Function | Arguments | Type |
+================+====================+====================+
| set_customdata | user_custom_data | Dict |
+----------------+--------------------+--------------------+

A Dict containing user specified key/value pairs can be passed in which will be added as custom data to each exception that is raised. This allows additional state to be supplied to help provide context for exceptions that are raised. When this is used in conjunction with the userCustomData argument on send_exception the 2 Dictionary instances will be merged with the argument to send_exception taking priority.

.. code:: python

client.set_customdata({'key1':'foo','key2':'bar'})

Custom grouping logic
---------------------

Expand Down Expand Up @@ -360,7 +384,7 @@ Troubleshooting

To see the HTTP response code from sending the message to raygun, `print client.send()` (as in line 27 of test.py). It will be 403 if an invalid API key was entered, and 202 if successful.

Create a thread in the official support forums at http://raygun.io/forums, and we'll help you out.
Create a thread in the official support forums at https://raygun.com/forums, and we'll help you out.

Changelog
=========
Expand Down
2 changes: 1 addition & 1 deletion python2/raygun4py/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
# 1) we don't load dependencies by storing it in __init__.py
# 2) we can import it in setup.py for the same reason
# 3) we can import it into your module module
__version__ = '4.3.2'
__version__ = '4.4.0'
2 changes: 1 addition & 1 deletion python3/raygun4py/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
# 1) we don't load dependencies by storing it in __init__.py
# 2) we can import it in setup.py for the same reason
# 3) we can import it into your module module
__version__ = '4.3.2'
__version__ = '4.4.0'