Commit Graph

3 Commits (jstirnaman/monolith-clients)

Author SHA1 Message Date
Scott Anderson f9ad60d7e2
Consolidate SQL reference docs (#5712)
* add source frontmatter for importing shared content

* update sql refrences docs to use shared source files

* updated note shortcodes to github-style alerts
2024-12-16 13:08:14 -07:00
Jason Stirnaman db059f99b0
Strategies to improve query performance: operations, number and size … (#5215)
* Strategies to improve query performance: operations, number and size of parquet files
Fixes #5108

- Add query performance strategies to optimize-queries

* Apply suggestions from code review

* Apply suggestions from code review

* Update content/influxdb/cloud-dedicated/query-data/execute-queries/optimize-queries.md

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>

* chore(v3): WIP query perf
Fixes #5108

* chore(v3): WIP: Query performance

* chore(v3): WIP: Explain the EXPLAIN report and indicators of query expense, performance problems.

* WIP: optimize queries - how to read a query plan, operators

* WIP: Read a query plan example 2

* WIP: moved how to read a query plan to its own page.

* WIP(v3): operators

* chore(v3): WIP add query plan info from DataFusion slides and @NGA-TRAN

* chore(v3): WIP read a query plan - explain tree format and reorganize

* WIP: query plan

- Adds Query Plan reference
- Completes Analyze a Query Plan, pending cleanup, continue at :471
- Added image from Nga's blog
- Updates EXPLAIN doc
- TODO: Create public docs for
https://github.com/influxdata/docs.influxdata.io/blob/main/content/operations/specifications/iox_runbooks/slow-queries.md

* chore(spelling): Vale config changes

- Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually.
- Move InfluxData spelling ignore list into the style.
- Reorganize custom (product) spelling lists to comply with Vale 3.x
- Add InfluxDB v3 terms

* chore(spelling): Vale config changes

- Add vale to package.json and use Yarn to manage the binary. You can use `npx vale` to run manually.
- Move InfluxData spelling ignore list into the style.
- Reorganize custom (product) spelling lists to comply with Vale 3.x
- Add InfluxDB v3 terms

* chore(v3): Reorg of query troubleshooting and optimizing docs

- Adds query-data/troubleshoot-and-optimize
- Splits optimize docs into troubleshoot and optimize docs
- Moves Flight response doc to flight-responses.md

* chore: Fixes broken links, typos, missing content, etc.

- Fixes various errors and style violations reported by Vale.
- Fixes broken links and missing content in glossaries.
- Fixes missing and extraneous whitespace.

* Apply suggestions from code review

* Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md

* chore(clustered): Query plan: Apply review suggestions

Co-Authored-By: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com>

* feature(v3): Analyze a query plan:

- Apply code formatting to plan implementor names
- Simplify some points
- Add links

* add query plan html diagram (#5365)

* Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/optimize-queries.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* fix(v3): finish the EXPLAIN descriptions and examples

* chore(tests): Setup a python venv in test containers

* fix(ci): Vale vocab

* fix(v3): Punctuation typo

* chore(ci): Update README

* fix(v3): Apply review suggestions and capitalization

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* fix(v3): Add note to optimize page and revise troubleshoot

* fix(v3): optimize-queries link

---------

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
Co-authored-by: Nga Tran <20850014+NGA-TRAN@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-15 18:40:38 -05:00
Scott Anderson 6223ef0ecd
Cloud Dedicated documentation (#4903)
* base changes for influxdb cloud dedicated

* removed unnecessary whitespace from dedicated homepage

* influxctl reference documentation (#4855)

* influxctl reference docs

* fixed typo, added auth0 token life span

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* more updates to influxctl docs

* update influxctl docs to address PR feedback

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* Add admin and manage databases sections to Cloud Dedicated (#4857)

* add admin and manage databases sections

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* added missing page descriptions to admin docs

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* Add token management documentation to Cloud Dedicated documentation (#4861)

* add manage tokens documentation to dedicated

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* update admin token docs to address PR feedback

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* Dedicated get started (#4878)

* WIP dedicated get started content

* fix(cst): infinite cardinality (#4851)

* WIP cloud dedicated get started

* feat(cloud-dedicated): WIP - write data to Cloud Dedicated

* fix(cloud-dedicated): grammar.

* feat(cloud-dedicated): WIP outline write methods, v1 API use

* fix(cloud-dedicated): dupe name.

* updated staging config, fixed dedicated page titles

* updated dedicated setup doc

* Cloud Dedicated primers v1 API: auth and write (#4865)

* feat(cloud-dedicated): v1 API with Cloud Dedicated
- Add /primers >> /api >> /v1 and /v2
- Move draft started in /write-data to /primers/api/v1
- Created code samples that still need testing
- v1 authentication schemes.

* fix(cloud-dedicated): list children pages

* wip(cloud-dedicated): v1 primer intro

* wip(cloud-dedicated): auth fixes.

* feat(cloud-dedicated): v1 API primer
- part of #4863, #4864
Still untested against CST:
- v1 auth methods
- v1 /write
  - Telegraf config
  - Precision
  - API sample code

* Update content/influxdb/cloud-dedicated/primers/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/_index.md

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v2/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v2/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update layouts/shortcodes/api/cloud/v2-prefer.html

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update shared/text/api/cloud-dedicated/basic-auth.js

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Dedicated v1 write (#4873)

* wip(v1): Revise v1 and add client library info.

* feat(cloud-dedicated): primer v1 API auth and writes

- Fixes for v1 auth and writes
- Configuring node and python v1 client libraries for Cloud Dedicated.

* fix(cloud-dedicated): v1 intros:

- Fix redundant intro
- Query intros

* Apply suggestions from code review

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Dedicated v2 write (#4875)

* fix(cloud-dedicated): v1 API primer:

- fix typo
- fix description

* wip(cloud-dedicated): v2 auth, write, Telegraf

* feat(cloud-dedicated): v2 API primer (#4874)

- v2 authentication
- Write using /api/v2/write
- Cleanup in v1

* Update content/influxdb/cloud-dedicated/primers/api/v2/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/primers/api/v1/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update shared/text/api/cloud-dedicated/token-auth-v2-write.sh

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* fix(cloud-dedicated): parameters for v1 and v2 writes

- testing proves that org can't be empty

Ongoing:
- writes with v2 client library appear to work, but I can't find the measurement when I query.
- v1 writes with curl respond with 404.

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Add Python and Go write instructions to Cloud Dedicated get started (#4876)

* added python and go write instructions to dedicated get started

* Add get started query guide to dedicated (#4877)

* Add get started query guide to dedicated

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* Apply suggestions from code review

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* Port reference content into dedicated (#4879)

* ported line protocol and sql reference

* port glossary to dedicated

* fix(cloud-dedicated): cleanup (#4880)

* fix(cloud-dedicated): v1 parameter values

- Fixes parameter values in requests.
- Based on inspection of the request (default port, content-type headers).
- Still not working in CST.

* fix(cloud-dedicated): cleanup auth description and list query tools.

* fix(cloud-dedicated): cleanup auth examples:

- remove boilerplate JS examples. Eventually replace with client lib examples.
- fix incorrect URL
- replace localhost with cloud2 host

* fix(cloud-dedicated): replace placeholders

* Add support for custom dedicated URLs (#4882)

* add support for custom dedicated urls

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* removed unnecessary conditional in influxdb-urls.js

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* add information about flight sql support (#4894)

* Update influxctl install and setup instructions (#4893)

* updated influxctl install and setup instructions

* added details to influxctl init page

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* Dedicated query data (#4895)

* WIP port query data section to dedicated

* updated database-name to iox-namespace-name

* updated grafana instructions

* update grafana install instructions

* updated images and links

* fixed broken links in query data section

* fix(cloud-dedicated): get-started write (#4890)

* fix(cloud-dedicated): package name typo

* fix(cloud-dedicated): URL missing query

* fix(cloud-dedicated): iox-namespace-name

* fix(cloud-dedicated): use get-started database name

* fix(cloud-dedicated): add auth-specific examples.

* fix(cloud-dedicated): use Bearer for v2 example

* fix(cloud-dedicated): add a note about token schemes and link to primer.

* fix(cloud-dedicated): org no longer required by API, remove from curl example

* fix(cloud-dedicated): use Bearer

* fix(cloud-dedicated): wordsmithing

* fix(cloud-dedicated): file name

* fix(cloud-dedicated): Go client works without org

* fix(cloud-dedicated): separate the commands for copy-pasting

* fix(cloud-dedicated): v1 API token authentication

* fix(cloud-dedicated): org parameter ignored, but needed in python clients

* fix(cloud-dedicated): v1 API examples and params for /query (#4897)

* fix(cloud-dedicated): minor word change (#4898)

* New homepage and structural changes (#4899)

* WIP first sweep of cloud-iox to cloud-serverless

* WIP iox to serverless content updates

* WIP iox to serverless updates in page templates and data files

* WIP new homepage

* chore(dedicated): copy best-practices from serverless

* fix(serverless): missing shortcut

* new homepage

* fix(dedicated): token links in v1 API primer

* chore(dedicated): write csv with Telegraf

* fix(serverless): write CSV with Telegraf

* updated homepage styles

* updated deps, fix unclosed shortcodes, fix light css

* fix product selector order

* updated database naming restrictions, add resource delete confirmation

* add cloud-ios to cloud-serverless redirect to edge.js

* remove sh from allowed extentions

* fix bug in redirect logic

* add sections to product dropdown (#4900)

* minor homepage css adjustment

* fixed page titles

* fixed more iox references in templates

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* Migrate 1.x data to dedicated (#4901)

* fix(serverless): cleanup

* chore(dedicated): Migrate 1.x data to dedicated

- Minimal adaptation of IOx to Dedicated for now.
- Use APIs for writing data (CLIs? pyinflux3 only writes CSV? Can't promote influxdb_iox for now)
- Add 2.x CLI warning

* fix(dedicated): URL typos

* Update content/influxdb/cloud-dedicated/write-data/migrate-data/_index.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/write-data/migrate-data/migrate-1x-to-cloud-dedicated.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/write-data/migrate-data/migrate-1x-to-cloud-dedicated.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/write-data/migrate-data/migrate-1x-to-cloud-dedicated.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/write-data/migrate-data/migrate-1x-to-cloud-dedicated.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb/cloud-dedicated/write-data/migrate-data/migrate-1x-to-cloud-dedicated.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* add step for requesting a cluster in dedicated setup

* minor content fixes in best practices

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-04-26 08:03:37 -06:00