Skip to content
This repository was archived by the owner on Jan 23, 2024. It is now read-only.

chore: release 3.0 #54

Merged
merged 3 commits into from
Aug 9, 2022
Merged
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
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,43 @@ Alternatively, you can pass the `--noreload` flag when running the Django
using the `--noreload` flag disables the autoreload feature in Django, which
means local changes to files will not be automatically picked up by Django.

### Experimental Firebase Realtime Database Backend

This functionality is available for release 3.0 onward of this agent.

The agent can be configured to use Firebase Realtime Database as a backend
instead of the deprecated Cloud Debugger service. If the Firebase backend is
used, breakpoints can be viewed and set using the Snapshot Debugger CLI instead
of the Cloud Console.

To use the Firebase backend, set the flag when enabling the agent:

```python
try:
import googleclouddebugger
googleclouddebugger.enable(use_firebase=True)
except ImportError:
pass
```

Additional configuration can be provided if necessary:

```python
try:
import googleclouddebugger
googleclouddebugger.enable(
use_firebase=True,
project_id='my-project-id',
firebase_db_url='https://my-database-url.firebaseio.com',
service_account_json_file='path/to/service_account.json',
)
except ImportError:
pass
```

See https://github.com/GoogleCloudPlatform/snapshot-debugger for more details.


## Flag Reference

The agent offers various flags to configure its behavior. Flags can be specified
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ google-auth>=1.0.0
google-auth-httplib2
google-api-python-client
google-api-core
firebase_admin
firebase_admin==5.2.0
pyyaml
2 changes: 1 addition & 1 deletion src/googleclouddebugger/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
# The major version should only change on breaking changes. Minor version
# changes go between regular updates. Instances running debuggers with
# different major versions will show up as two different debuggees.
__version__ = '2.19'
__version__ = '3.0'
1 change: 1 addition & 0 deletions src/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ def ReadConfig(section, value, default):
'google-auth>=1.0.0',
'google-auth-httplib2',
'google-api-core',
'firebase-admin==5.2.0',
'pyyaml',
],
packages=['googleclouddebugger'],
Expand Down