docs: Update bot detection and ClickHouse functions for IP-based detection#18195
Open
inkeep[bot] wants to merge 2 commits into
Open
docs: Update bot detection and ClickHouse functions for IP-based detection#18195inkeep[bot] wants to merge 2 commits into
inkeep[bot] wants to merge 2 commits into
Conversation
Reflects PR #68232 which adds IP-range bot detection alongside user agent pattern matching. Classification functions now accept an optional second `ip` argument, and virtual properties automatically pass both UA and IP. Currently covers Google's published crawler ranges.
PR #68232 allowlisted 23 ClickHouse IP functions in HogQL for use in the SQL editor. This adds them to the reference documentation.
Contributor
Deploy preview
|
Contributor
|
Vale prose linter → found 0 errors, 16 warnings, 8 suggestions in your markdown Full report → Copy the linter results into an LLM to batch-fix issues. Linter being weird? Update the rules!
|
| Line | Severity | Message | Rule |
|---|---|---|---|
| 16:78 | warning | Avoid trivializing words. 'simply' can sound dismissive to the reader. | PostHogDocs.Trivializers |
| 625:4 | warning | 'Nullable' is a possible misspelling. | PostHogBase.Spelling |
contents/docs/web-analytics/bot-detection.mdx — 0 errors, 14 warnings, 8 suggestions
| Line | Severity | Message | Rule |
|---|---|---|---|
| 17:145 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 21:93 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 21:226 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 49:199 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 53:130 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 53:242 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 53:538 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 57:55 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 61:49 | warning | 'bot's' is a possible misspelling. | PostHogBase.Spelling |
| 73:85 | warning | 'GPTBot' is a possible misspelling. | PostHogBase.Spelling |
| 74:85 | warning | 'Googlebot' is a possible misspelling. | PostHogBase.Spelling |
| 74:96 | warning | 'Bingbot' is a possible misspelling. | PostHogBase.Spelling |
| 83:71 | warning | 'GPTBot' is a possible misspelling. | PostHogBase.Spelling |
| 84:104 | warning | 'Applebot' is a possible misspelling. | PostHogBase.Spelling |
| 86:71 | warning | 'Googlebot' is a possible misspelling. | PostHogBase.Spelling |
| 86:82 | warning | 'Bingbot' is a possible misspelling. | PostHogBase.Spelling |
| 89:71 | warning | 'Pingdom' is a possible misspelling. | PostHogBase.Spelling |
| 90:77 | warning | 'Wget' is a possible misspelling. | PostHogBase.Spelling |
| 90:100 | warning | 'axios' is a possible misspelling. | PostHogBase.Spelling |
| 133:92 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 169:30 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 177:138 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
Contributor
Bundle reportTotal JS (gzip)6.29 MiB (+0.1 KiB / +0.0%) Eager graph (static-import closure per entrypoint)
Largest modules in the
|
| Module | Size |
|---|---|
css ./node_modules/.pnpm/css-loader@5.2.7_webpack@5.101.3/node_modules/css-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[1]!./node_modules/.pnpm/postcss-loader@4.3.0_postcss@8.5.6_webpack@5.101.3/node_modules/postcss-loader/dist/cjs.js??ruleSet[1].rules[8].oneOf[1].use[2]!./src/styles/global.css |
707.7 KiB |
./src/components/Stickers/Stickers.tsx |
696.4 KiB |
./.cache/caches/gatsby-plugin-mdx/mdx-scopes-dir/31a094f140f119e73085d847ae81b99b.js + 2 modules |
585.5 KiB |
./node_modules/.pnpm/@radix-ui+react-icons@1.3.2_react@18.3.1/node_modules/@radix-ui/react-icons/dist/react-icons.esm.js |
481.4 KiB |
./node_modules/.pnpm/@codemirror+view@6.38.2/node_modules/@codemirror/view/dist/index.js |
458.1 KiB |
./node_modules/.pnpm/rehype-raw@7.0.0/node_modules/rehype-raw/lib/index.js + 29 modules |
395.1 KiB |
./node_modules/.pnpm/@posthog+icons@0.36.6_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@posthog/icons/dist/posthog-icons.cjs.js |
364.8 KiB |
./node_modules/.pnpm/@posthog+icons@0.36.6_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@posthog/icons/dist/posthog-icons.es.js |
354.8 KiB |
./src/hooks/useCustomers.tsx + 54 modules |
353.9 KiB |
./node_modules/.pnpm/react-markdown@8.0.7_@types+react@16.14.66_react@18.3.1/node_modules/react-markdown/lib/react-markdown.js + 88 modules |
351.4 KiB |
./node_modules/.pnpm/cloudinary-core@2.14.0_lodash@4.17.21/node_modules/cloudinary-core/cloudinary-core.js |
281.9 KiB |
./src/components/ProductComparisonTable/index.tsx + 116 modules |
267.6 KiB |
./node_modules/.pnpm/@codesandbox+sandpack-react@2.20.0_react-dom@18.3.1_react@18.3.1__react@18.3.1/node_modules/@codesandbox/sandpack-react/dist/index.mjs |
266.6 KiB |
./node_modules/.pnpm/d3@7.9.0/node_modules/d3/src/index.js + 208 modules |
247.4 KiB |
./src/components/Pricing/PricingSlider/Slider.tsx + 87 modules |
239.9 KiB |
Eager-graph budgets are report-only until a baseline is established. Sizes are gzip of public/**/*.js; eager size is webpack module source bytes.
Contributor
|
Hey @lricoy! This docs PR was generated for you by an agent. You're responsible for reviewing and merging it into production.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
This PR updates documentation to reflect the IP-based bot detection feature added in PostHog/posthog#68232.
Bot detection documentation (
contents/docs/web-analytics/bot-detection.mdx)ipargument on all six classification functions (isLikelyBot,getTrafficType,getTrafficCategory,getBotType,getBotName,getBotOperator)[, ip]optional parameter$virt_*properties now automatically pass both UA and IPClickHouse functions reference (
contents/docs/sql/clickhouse-functions.mdx)IPv4NumToString,IPv4StringToNum(+ OrDefault/OrNull variants)IPv6NumToString,IPv6StringToNum(+ OrDefault/OrNull variants)toIPv4(+ OrDefault/OrNull/OrZero variants)toIPv6(+ OrDefault/OrNull/OrZero variants)IPv4ToIPv6,isIPv4String,isIPv6StringisIPAddressInRange,IPv4CIDRToRange,IPv6CIDRToRange,cutIPv6This PR was created by the Inkeep Content Writer agent, which is maintained by the Docs and Wizard team. Please reach out on Slack for help if needed.