How to debug custom rest endpoint in development

Open
#25 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
docker, python
Domain
api, documentation

Research direction

Start by reviewing the custom REST endpoint guide and the Splunk Docker development setup described in the issue. Document a local Python debugging workflow that avoids refreshing the Splunk environment after every code change, and define done as a reproducible development procedure for custom endpoints.

Written by the indexing model from the issue text.

Description

Hi everyone,

I am following guide to create new custom REST endpoint, but I have problem on debug my code in local.
How I can debug python code local.
Currently, I am using Splunk Docker and mount local app to Splunk container. After every time changed code, I must refresh debug on Splunk. It is very taken time.
Does everyone have other way to debug python code on Splunk.

Thank.

Dominant language
JavaScript
Stars
155
Forks
84
PR merge metrics
No merged PRs in 30d

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • No pull request template
  • No 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.

More from splunk/splunk-app-examples

All issues in splunk/splunk-app-examples

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.