pulp / pulp/pulpcore

Document how to enable sql debug in pulp logs

Open
#5,830 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation Task
Dominant language
Python
Stars
598
Forks
168
Avg merge
1d 4h
Merged PRs (30d)
86

Description

Request

As an admin (and developer),
I want to have a reference snippet on how to enable SQL debugging in the pulp logs,
so I can troubleshoot the relation between API calls and database activity.

Context

This was asked in pulp internal channels, and I personally think this would be helpful too.

Probably a section to be added here:
https://pulpproject.org/pulpcore/docs/admin/guides/troubleshooting/

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Pulp admin troubleshooting guide at pulpcore/docs/admin/guides/troubleshooting/. Add a reference snippet explaining how to enable SQL debugging in Pulp logs and use it to relate API calls to database activity; the documentation is done when an administrator can follow it to obtain the relevant SQL logs.

Written by the indexing model from the issue text.

Assessment

Tech stack
sql
Domain
databases, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.