You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/07/27 05:49:03 UTC
[GitHub] [apisix] navendu-pottekkat opened a new pull request, #7544: docs: update debug mode docs
navendu-pottekkat opened a new pull request, #7544:
URL: https://github.com/apache/apisix/pull/7544
Signed-off-by: Navendu Pottekkat <na...@gmail.com>
### Description
Updates "Debug mode" page and moves it to the "Development" section instead of the architecture docs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] juzhiyuan merged pull request #7544: docs: update debug mode docs
Posted by GitBox <gi...@apache.org>.
juzhiyuan merged PR #7544:
URL: https://github.com/apache/apisix/pull/7544
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] navendu-pottekkat commented on pull request #7544: docs: update debug mode docs
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on PR #7544:
URL: https://github.com/apache/apisix/pull/7544#issuecomment-1197601174
@guoqqqi Fixed the conflict.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] bisakhmondal commented on a diff in pull request #7544: docs: update debug mode docs
Posted by GitBox <gi...@apache.org>.
bisakhmondal commented on code in PR #7544:
URL: https://github.com/apache/apisix/pull/7544#discussion_r931140757
##########
docs/en/latest/debug-mode.md:
##########
@@ -0,0 +1,137 @@
+---
+id: debug-mode
+title: Debug mode
+keywords:
+ - API gateway
+ - Apache APISIX
+ - Debug mode
+description: Guide for enabling debug mode in Apache APISIX.
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+You can use APISIX's debug mode to troubleshoot your configuration.
Review Comment:
```suggestion
You can use APISIX debug mode to troubleshoot your configuration.
```
With another heads up, something like
```suggestion
You can use APISIX debug mode to troubleshoot your configuration. Currently we support the following debug modes
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] yzeng25 commented on a diff in pull request #7544: docs: update debug mode docs
Posted by GitBox <gi...@apache.org>.
yzeng25 commented on code in PR #7544:
URL: https://github.com/apache/apisix/pull/7544#discussion_r931109297
##########
docs/en/latest/debug-mode.md:
##########
@@ -0,0 +1,137 @@
+---
+id: debug-mode
+title: Debug mode
+keywords:
+ - API gateway
+ - Apache APISIX
+ - Debug mode
+description: Guide for enabling debug mode in Apache APISIX.
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+You can use APISIX's debug mode to troubleshoot your configuration.
Review Comment:
Yeah you are right.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] yzeng25 commented on a diff in pull request #7544: docs: update debug mode docs
Posted by GitBox <gi...@apache.org>.
yzeng25 commented on code in PR #7544:
URL: https://github.com/apache/apisix/pull/7544#discussion_r930653787
##########
docs/en/latest/debug-mode.md:
##########
@@ -0,0 +1,137 @@
+---
+id: debug-mode
+title: Debug mode
+keywords:
+ - API gateway
+ - Apache APISIX
+ - Debug mode
+description: Guide for enabling debug mode in Apache APISIX.
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+You can use APISIX's debug mode to troubleshoot your configuration.
Review Comment:
```suggestion
You can use APISIX's debug mode to troubleshoot your configurations.
```
##########
docs/en/latest/debug-mode.md:
##########
@@ -0,0 +1,137 @@
+---
+id: debug-mode
+title: Debug mode
+keywords:
+ - API gateway
+ - Apache APISIX
+ - Debug mode
+description: Guide for enabling debug mode in Apache APISIX.
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+You can use APISIX's debug mode to troubleshoot your configuration.
+
+## Basic debug mode
+
+You can enable the basic debug mode by adding this line to your debug configuration file (`conf/debug.yaml`):
+
+```yaml title="conf/debug.yaml"
+basic:
+ enable: true
+```
+
+:::note
+
+For APISIX releases priot to v2.10, basic debug mode is enabled by setting `apisix.enable_debug = true` in your configuration file (`conf/config.yaml`).
Review Comment:
typo
```suggestion
For APISIX releases prior to v2.10, basic debug mode is enabled by setting `apisix.enable_debug = true` in your configuration file (`conf/config.yaml`).
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] navendu-pottekkat commented on a diff in pull request #7544: docs: update debug mode docs
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on code in PR #7544:
URL: https://github.com/apache/apisix/pull/7544#discussion_r930981307
##########
docs/en/latest/debug-mode.md:
##########
@@ -0,0 +1,137 @@
+---
+id: debug-mode
+title: Debug mode
+keywords:
+ - API gateway
+ - Apache APISIX
+ - Debug mode
+description: Guide for enabling debug mode in Apache APISIX.
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+You can use APISIX's debug mode to troubleshoot your configuration.
+
+## Basic debug mode
+
+You can enable the basic debug mode by adding this line to your debug configuration file (`conf/debug.yaml`):
+
+```yaml title="conf/debug.yaml"
+basic:
+ enable: true
+```
+
+:::note
+
+For APISIX releases priot to v2.10, basic debug mode is enabled by setting `apisix.enable_debug = true` in your configuration file (`conf/config.yaml`).
Review Comment:
Updated.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] navendu-pottekkat commented on a diff in pull request #7544: docs: update debug mode docs
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on code in PR #7544:
URL: https://github.com/apache/apisix/pull/7544#discussion_r930980401
##########
docs/en/latest/debug-mode.md:
##########
@@ -0,0 +1,137 @@
+---
+id: debug-mode
+title: Debug mode
+keywords:
+ - API gateway
+ - Apache APISIX
+ - Debug mode
+description: Guide for enabling debug mode in Apache APISIX.
+---
+
+<!--
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+-->
+
+You can use APISIX's debug mode to troubleshoot your configuration.
Review Comment:
A deployment of APISIX will have a configuration. Considering a configuration for APISIX as a whole. Wouldn't it be better to keep it singular itself?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] guoqqqi commented on pull request #7544: docs: update debug mode docs
Posted by GitBox <gi...@apache.org>.
guoqqqi commented on PR #7544:
URL: https://github.com/apache/apisix/pull/7544#issuecomment-1197543574
Hello, @bisakhmondal There are a number of conflicts that need to be resolved, Can we fix them first?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] navendu-pottekkat commented on pull request #7544: docs: update debug mode docs
Posted by GitBox <gi...@apache.org>.
navendu-pottekkat commented on PR #7544:
URL: https://github.com/apache/apisix/pull/7544#issuecomment-1196296343
// @hf400159 @kwanhur @avinal @yzeng25 @juzhiyuan Please review when you are available.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org