summaryrefslogtreecommitdiff
path: root/python-sentry-msteams-plugin.spec
blob: e00c3d86d0e1e5821373b3420d1c52d987feeb94 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
%global _empty_manifest_terminate_build 0
Name:		python-sentry-msteams-plugin
Version:	0.3.0
Release:	1
Summary:	Sentry plugin for sending events to Microsoft Teams
License:	GPLv2
URL:		https://github.com/kingcody/sentry-msteams-plugin
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/8b/ea/b7f2b1f4e79a75abe13bfca5f40e823a1f814f5e015feaa8bcb7336d64d0/sentry-msteams-plugin-0.3.0.tar.gz
BuildArch:	noarch

Requires:	python3-sentry

%description
# Microsoft Teams Plugin for Sentry

Microsoft Teams Integration for [Sentry Error Tracking Software](https://sentry.io/welcome/).

Based off the [Sentry Plugins](https://github.com/getsentry/sentry-plugins) written by the Sentry Team. Thanks for the excellent tool guys!

## Installation Instructions

The Sentry MS Teams plugin is available in PyPi as [sentry-msteams](https://pypi.org/project/sentry-msteams-plugin/). To install it, in your `requirements.txt` file, add the below package name:

```
sentry-msteams-plugin
```

## Configuration

In your project, locate the Integrations management screen and click 'Configure Plugin' below the 'Microsoft Teams' item.

There are two configuration options, the WebHook URL to send messages to, and a toggle to include additional metadata about the error in the Teams message.

To add Sentry alerts to your channel, configure a new Incoming Webhook connector in Microsoft Teams and paste the URL into the configuration screen, then click 'Save Changes'. Make sure to use the standard webhook connector when configuring MS Teams, as there is also a Micsorosft provided 'Sentry' connector but this requires a specific Microsoft provided integration which is not supported by sentry-msteams.

When ready, click 'Test Plugin' to generate an exception and send a message to your chosen WebHook URL.

## Troubleshooting

When running in Docker, Sentry occasionally fails to load the plugin on the worker container. This can result in not sending alerts when triggered, and you'll often see a KeyError in the logs such as `KeyError(u'msteams',)`. To resolve, restart the worker container and fire another alert.

### Important Note for Sentry 9

Sentry 9 introduced some additional dependencies on specific versions of Redis which appear to cause issues installing plugins.

To work around this issue, you can add the below line to the top of your `requirements.txt` file.

```
redis-py-cluster==1.3.4
```




%package -n python3-sentry-msteams-plugin
Summary:	Sentry plugin for sending events to Microsoft Teams
Provides:	python-sentry-msteams-plugin
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-sentry-msteams-plugin
# Microsoft Teams Plugin for Sentry

Microsoft Teams Integration for [Sentry Error Tracking Software](https://sentry.io/welcome/).

Based off the [Sentry Plugins](https://github.com/getsentry/sentry-plugins) written by the Sentry Team. Thanks for the excellent tool guys!

## Installation Instructions

The Sentry MS Teams plugin is available in PyPi as [sentry-msteams](https://pypi.org/project/sentry-msteams-plugin/). To install it, in your `requirements.txt` file, add the below package name:

```
sentry-msteams-plugin
```

## Configuration

In your project, locate the Integrations management screen and click 'Configure Plugin' below the 'Microsoft Teams' item.

There are two configuration options, the WebHook URL to send messages to, and a toggle to include additional metadata about the error in the Teams message.

To add Sentry alerts to your channel, configure a new Incoming Webhook connector in Microsoft Teams and paste the URL into the configuration screen, then click 'Save Changes'. Make sure to use the standard webhook connector when configuring MS Teams, as there is also a Micsorosft provided 'Sentry' connector but this requires a specific Microsoft provided integration which is not supported by sentry-msteams.

When ready, click 'Test Plugin' to generate an exception and send a message to your chosen WebHook URL.

## Troubleshooting

When running in Docker, Sentry occasionally fails to load the plugin on the worker container. This can result in not sending alerts when triggered, and you'll often see a KeyError in the logs such as `KeyError(u'msteams',)`. To resolve, restart the worker container and fire another alert.

### Important Note for Sentry 9

Sentry 9 introduced some additional dependencies on specific versions of Redis which appear to cause issues installing plugins.

To work around this issue, you can add the below line to the top of your `requirements.txt` file.

```
redis-py-cluster==1.3.4
```




%package help
Summary:	Development documents and examples for sentry-msteams-plugin
Provides:	python3-sentry-msteams-plugin-doc
%description help
# Microsoft Teams Plugin for Sentry

Microsoft Teams Integration for [Sentry Error Tracking Software](https://sentry.io/welcome/).

Based off the [Sentry Plugins](https://github.com/getsentry/sentry-plugins) written by the Sentry Team. Thanks for the excellent tool guys!

## Installation Instructions

The Sentry MS Teams plugin is available in PyPi as [sentry-msteams](https://pypi.org/project/sentry-msteams-plugin/). To install it, in your `requirements.txt` file, add the below package name:

```
sentry-msteams-plugin
```

## Configuration

In your project, locate the Integrations management screen and click 'Configure Plugin' below the 'Microsoft Teams' item.

There are two configuration options, the WebHook URL to send messages to, and a toggle to include additional metadata about the error in the Teams message.

To add Sentry alerts to your channel, configure a new Incoming Webhook connector in Microsoft Teams and paste the URL into the configuration screen, then click 'Save Changes'. Make sure to use the standard webhook connector when configuring MS Teams, as there is also a Micsorosft provided 'Sentry' connector but this requires a specific Microsoft provided integration which is not supported by sentry-msteams.

When ready, click 'Test Plugin' to generate an exception and send a message to your chosen WebHook URL.

## Troubleshooting

When running in Docker, Sentry occasionally fails to load the plugin on the worker container. This can result in not sending alerts when triggered, and you'll often see a KeyError in the logs such as `KeyError(u'msteams',)`. To resolve, restart the worker container and fire another alert.

### Important Note for Sentry 9

Sentry 9 introduced some additional dependencies on specific versions of Redis which appear to cause issues installing plugins.

To work around this issue, you can add the below line to the top of your `requirements.txt` file.

```
redis-py-cluster==1.3.4
```




%prep
%autosetup -n sentry-msteams-plugin-0.3.0

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-sentry-msteams-plugin -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Wed May 31 2023 Python_Bot <Python_Bot@openeuler.org> - 0.3.0-1
- Package Spec generated