summaryrefslogtreecommitdiff
path: root/python-citibox-gcloud-logger.spec
blob: a6c84ce78c8c11b4965d35bddf5030ea22355224 (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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
%global _empty_manifest_terminate_build 0
Name:		python-citibox-gcloud-logger
Version:	0.5.1
Release:	1
Summary:	Citibox Google cloud logging tools
License:	MIT License
URL:		https://citibox.com
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/31/94/6009251bcd6aab7e3de1937db3fcf6d4f2b525475141f82f0b1d4b9658f8/citibox-gcloud-logger-0.5.1.tar.gz
BuildArch:	noarch


%description
# gcloud-logger
Python log wrapper for gcloud logging format

## How to use it?

Create your filter classes as needed, extending BaseContextFilter i.e.
````python
from citibox.gcloudlogger import BaseContextFilter


class MyTestFilter(BaseContextFilter):
    def __init__(self):
        super().__init__()
        self.some_attribute = "Some Value"

    @staticmethod
    def filter_name():
        return "my_test_filter"


    def to_dict(self) -> dict:
        return {
            "some_attribute": self.some_attribute
        }
````

Get logger from generated dict:
1. Import logging required
    ```python
    import logging
    from logging.config import dictConfig
    ```
2. Import GCloudLogConfig:
    ```python
    from citibox.gcloudlogger import GCloudLogConfig
    ```

3. Instance the library with your custom filters and set the logger config:
    ```python
    my_log_config = GCloudLogConfig(MyTestFilter)
    dictConfig(my_log_config.config)
    ```
4. Use the logger as normally:
    ```python
   logger = logging.getLogger()

   logger.info("something good is happening")
    ```

 Also, you can add more loggers if needed:
 ```python
    import logging
    from logging.config import dictConfig
    from citibox.gcloudlogger import GCloudLogConfig

    my_log_config = GCloudLogConfig(AnyFilter)
    my_log_config.add_logger("new_logger", level=logging.INFO)
    dictConfig(my_log_config.config) 
```

And, add filters after the creation of the log config class:
```python
    import logging
    from logging.config import dictConfig
    from citibox.gcloudlogger import GCloudLogConfig

    my_log_config = GCloudLogConfig(AnyFilter)
    my_log_config.add_filter(AnotherFilterClass)
```

### Using Middlewares
#### Falcon
There is a Falcon middleware ready for logging Request and Response.
Use [Falcon middlewares](https://falcon.readthedocs.io/en/stable/api/middleware.html) adding the included class:
```python
import falcon
from citibox.gcloudlogger.contrib.falcon import FalconMiddleware

app = falcon.API(middleware=[FalconMiddleware()])
```

#### Django
in your config file add:
```python
MIDDLEWARE = [
    'citibox.gcloudlogger.contrib.django.DjangoMiddleware',
    ...
]
```




%package -n python3-citibox-gcloud-logger
Summary:	Citibox Google cloud logging tools
Provides:	python-citibox-gcloud-logger
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-citibox-gcloud-logger
# gcloud-logger
Python log wrapper for gcloud logging format

## How to use it?

Create your filter classes as needed, extending BaseContextFilter i.e.
````python
from citibox.gcloudlogger import BaseContextFilter


class MyTestFilter(BaseContextFilter):
    def __init__(self):
        super().__init__()
        self.some_attribute = "Some Value"

    @staticmethod
    def filter_name():
        return "my_test_filter"


    def to_dict(self) -> dict:
        return {
            "some_attribute": self.some_attribute
        }
````

Get logger from generated dict:
1. Import logging required
    ```python
    import logging
    from logging.config import dictConfig
    ```
2. Import GCloudLogConfig:
    ```python
    from citibox.gcloudlogger import GCloudLogConfig
    ```

3. Instance the library with your custom filters and set the logger config:
    ```python
    my_log_config = GCloudLogConfig(MyTestFilter)
    dictConfig(my_log_config.config)
    ```
4. Use the logger as normally:
    ```python
   logger = logging.getLogger()

   logger.info("something good is happening")
    ```

 Also, you can add more loggers if needed:
 ```python
    import logging
    from logging.config import dictConfig
    from citibox.gcloudlogger import GCloudLogConfig

    my_log_config = GCloudLogConfig(AnyFilter)
    my_log_config.add_logger("new_logger", level=logging.INFO)
    dictConfig(my_log_config.config) 
```

And, add filters after the creation of the log config class:
```python
    import logging
    from logging.config import dictConfig
    from citibox.gcloudlogger import GCloudLogConfig

    my_log_config = GCloudLogConfig(AnyFilter)
    my_log_config.add_filter(AnotherFilterClass)
```

### Using Middlewares
#### Falcon
There is a Falcon middleware ready for logging Request and Response.
Use [Falcon middlewares](https://falcon.readthedocs.io/en/stable/api/middleware.html) adding the included class:
```python
import falcon
from citibox.gcloudlogger.contrib.falcon import FalconMiddleware

app = falcon.API(middleware=[FalconMiddleware()])
```

#### Django
in your config file add:
```python
MIDDLEWARE = [
    'citibox.gcloudlogger.contrib.django.DjangoMiddleware',
    ...
]
```




%package help
Summary:	Development documents and examples for citibox-gcloud-logger
Provides:	python3-citibox-gcloud-logger-doc
%description help
# gcloud-logger
Python log wrapper for gcloud logging format

## How to use it?

Create your filter classes as needed, extending BaseContextFilter i.e.
````python
from citibox.gcloudlogger import BaseContextFilter


class MyTestFilter(BaseContextFilter):
    def __init__(self):
        super().__init__()
        self.some_attribute = "Some Value"

    @staticmethod
    def filter_name():
        return "my_test_filter"


    def to_dict(self) -> dict:
        return {
            "some_attribute": self.some_attribute
        }
````

Get logger from generated dict:
1. Import logging required
    ```python
    import logging
    from logging.config import dictConfig
    ```
2. Import GCloudLogConfig:
    ```python
    from citibox.gcloudlogger import GCloudLogConfig
    ```

3. Instance the library with your custom filters and set the logger config:
    ```python
    my_log_config = GCloudLogConfig(MyTestFilter)
    dictConfig(my_log_config.config)
    ```
4. Use the logger as normally:
    ```python
   logger = logging.getLogger()

   logger.info("something good is happening")
    ```

 Also, you can add more loggers if needed:
 ```python
    import logging
    from logging.config import dictConfig
    from citibox.gcloudlogger import GCloudLogConfig

    my_log_config = GCloudLogConfig(AnyFilter)
    my_log_config.add_logger("new_logger", level=logging.INFO)
    dictConfig(my_log_config.config) 
```

And, add filters after the creation of the log config class:
```python
    import logging
    from logging.config import dictConfig
    from citibox.gcloudlogger import GCloudLogConfig

    my_log_config = GCloudLogConfig(AnyFilter)
    my_log_config.add_filter(AnotherFilterClass)
```

### Using Middlewares
#### Falcon
There is a Falcon middleware ready for logging Request and Response.
Use [Falcon middlewares](https://falcon.readthedocs.io/en/stable/api/middleware.html) adding the included class:
```python
import falcon
from citibox.gcloudlogger.contrib.falcon import FalconMiddleware

app = falcon.API(middleware=[FalconMiddleware()])
```

#### Django
in your config file add:
```python
MIDDLEWARE = [
    'citibox.gcloudlogger.contrib.django.DjangoMiddleware',
    ...
]
```




%prep
%autosetup -n citibox-gcloud-logger-0.5.1

%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-citibox-gcloud-logger -f filelist.lst
%dir %{python3_sitelib}/*

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

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