feat(apm): Add markers to be used for inline tracing docs for the product (#1784)

Author: dashed

__tests__/__snapshots__/documentation.js.snap

@@ -35,6 +35,7 @@ Array [
   "_platforms/node/connect.json",
   "_platforms/node/express.json",
   "_platforms/node/koa.json",
+  "_platforms/node/tracing.json",
   "_platforms/objc.json",
   "_platforms/php.json",
   "_platforms/php/laravel.json",
@@ -56,6 +57,7 @@ Array [
   "_platforms/python/rq.json",
   "_platforms/python/sanic.json",
   "_platforms/python/tornado.json",
+  "_platforms/python/tracing.json",
   "_platforms/python/tryton.json",
   "_platforms/python/wsgi.json",
   "_platforms/react-native.json",
@@ -276,6 +278,8 @@ Array [
   "meta/ip-ranges/index.html",
   "meta/soc2/index.html",
   "meta/terms/index.html",
+  "performance-monitoring/configuration/node/index.html",
+  "performance-monitoring/configuration/python/index.html",
   "performance-monitoring/discover-queries/index.html",
   "performance-monitoring/discover-queries/query-builder/index.html",
   "performance-monitoring/distributed-tracing/index.html",

src/_data/platforms.yml

@@ -1,3 +1,12 @@
+-
+      slug: tracing
+      support_level: production
+      type: framework
+      name: Node.js
+      doc_link: /performance-monitoring/setup/?platform=node
+      wizard_parent: node
+      wizard:
+        - _documentation/performance-monitoring/configuration/node.md#node-tracing
 -
       slug: koa
       support_level: production
@@ -141,6 +150,15 @@
       doc_link: /clients/python/
       case_style: snake_case
       superseded_by: python
+-
+      slug: tracing
+      support_level: production
+      type: language
+      name: Python
+      doc_link: /performance-monitoring/setup/?platform=python
+      wizard_parent: python
+      wizard:
+            - _documentation/performance-monitoring/configuration/python.md#python-tracing
 -
       slug: pyramid
       support_level: production

src/_includes/components/platform_content.html

@@ -98,7 +98,7 @@
       {% include_relative {{ __relative_path }} %}
       {%- endcapture -%}
       <div class="tab-pane{% if __is_default %} show active{% endif %}" id="{{ __uniq }}-{{ __slug }}" data-slug="{{ __slug }}" role="tabpanel" aria-labelledby="{{ __uniq }}-{{ __slug }}-tab">
-        {{ __content | markdownify }}
+        {{ __content | strip_front_matter | markdownify }}
       </div>
     {%- endfor -%}
   </div>

src/_plugins/document_path_tree.rb

@@ -6,7 +6,15 @@ def sort_key(item)
       [100, "zzzzz"]
     end
   end
-  
+
+  def show_item(item)
+    if !item["document"].nil?
+      !item["document"].data["hide_from_sidebar"]
+    else
+      true
+    end
+  end
+
   def tree_for(docs, root)
     tree = []
 
@@ -33,30 +41,39 @@ def tree_for(docs, root)
 
       items = new_root.nil? ? nil : tree_for(docs_without_index, new_root)
 
+      should_hide_from_sidebar = false
+
       if !items.nil?
         items.sort_by! { |i| sort_key(i) }
+
+        num_of_items_before = items.length()
+        items.select! { |i| show_item(i) }
+
+        should_hide_from_sidebar = items.length() < num_of_items_before && items.length() == 0
       end
 
-      hash = {
-        "slug" => name,
-        "name" => document.nil? ? name : document.data["title"],
-        "document" => document.nil? ? nil : document,
-        "items" => items,
-        "parent_path" => new_root
-      }
+      if !should_hide_from_sidebar
+        hash = {
+          "slug" => name,
+          "name" => document.nil? ? name : document.data["title"],
+          "document" => document.nil? ? nil : document,
+          "items" => items,
+          "parent_path" => new_root
+        }
 
-      tree.push hash
+        tree.push hash
+      end
     end
     tree
   end
-  
+
   def sort_tree(node)
     if !node["items"].nil?
       node["items"].sort_by! { |i| sort_key(i) }
       node["items"].each { |n| sort_tree(n) }
     end
   end
-  
+
   mapped = site.collections.map {|c| c[1].docs}
   documents = mapped.flatten()
   tree = tree_for(documents, "")

src/_plugins/strip_front_matter.rb

@@ -0,0 +1,9 @@
+module Jekyll
+  module StripFrontMatter
+    def strip_front_matter(input)
+      input.to_s.gsub(/^---\n.*\n---/, '')
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::StripFrontMatter)

src/collections/_documentation/performance-monitoring/configuration/node.md

@@ -1,3 +1,7 @@
+---
+hide_from_sidebar: true
+---
+
 To access our tracing features, you will need to install our Tracing integration.
 
 **Node**
@@ -64,6 +68,8 @@ Spans are instrumented for the following operations within a transaction:
 
 **Manual Instrumentation**
 
+<!-- WIZARD node-tracing -->
+
 To manually instrument a specific region of your code, you can create a transaction to capture it.
 
 The following example creates a transaction for a part of the code that contains an expensive operation (for example, `processItem`), and sends the result to Sentry:
@@ -82,4 +88,6 @@ app.use(function processItems(req, res, next) {
       next();
   })
 });
-```
+```
+
+<!-- ENDWIZARD -->

src/collections/_documentation/performance-monitoring/configuration/python.md

@@ -1,3 +1,7 @@
+---
+hide_from_sidebar: true
+---
+
 To get started with performance monitoring using Sentry's Python SDK, first install the `@sentry/apm` package:
 
 ```
@@ -59,6 +63,8 @@ sentry_sdk.init(
 
 **Manual Instrumentation**
 
+<!-- WIZARD python-tracing -->
+
 To manually instrument certain regions of your code, you can create a transaction to capture them.
 
 The following example creates a transaction for a scope that contains an expensive operation (for example, `process_item`), and sends the result to Sentry:
@@ -91,3 +97,5 @@ def process_item(item):
       span.set_tag("http.status_code", response.status_code)
       span.set_data("http.foobarsessionid", get_foobar_sessionid())
 ```
+
+<!-- ENDWIZARD -->