Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add basic tuning guide, getting started page, updated clustering docs #7629

Merged
merged 19 commits into from
May 16, 2019
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/_redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -165,5 +165,6 @@
{"source": "development/community-extensions/kafka-simple.html", "target": "../extensions-contrib/kafka-simple.html"},
{"source": "development/community-extensions/rabbitmq.html", "target": "../extensions-contrib/rabbitmq.html"},
{"source": "development/extensions-core/namespaced-lookup.html", "target": "lookups-cached-global.html"},
{"source": "operations/insert-segment-to-db.html", "target": "../index.html"}
{"source": "operations/insert-segment-to-db.html", "target": "../index.html"},
{"source": "operations/performance-faq.html", "target": "../operations/basic-cluster-tuning.html"}
]
33 changes: 33 additions & 0 deletions docs/content/configuration/logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,36 @@ An example log4j2.xml ships with Druid under config/_common/log4j2.xml, and a sa
</Loggers>
</Configuration>
```

## My logs are really chatty, can I set them to asynchronously write?

Yes, using a `log4j2.xml` similar to the following causes some of the more chatty classes to write asynchronously:

```
<?xml version="1.0" encoding="UTF-8" ?>
<Configuration status="WARN">
<Appenders>
<Console name="Console" target="SYSTEM_OUT">
<PatternLayout pattern="%d{ISO8601} %p [%t] %c - %m%n"/>
</Console>
</Appenders>
<Loggers>
<AsyncLogger name="org.apache.druid.curator.inventory.CuratorInventoryManager" level="debug" additivity="false">
<AppenderRef ref="Console"/>
</AsyncLogger>
<AsyncLogger name="org.apache.druid.client.BatchServerInventoryView" level="debug" additivity="false">
<AppenderRef ref="Console"/>
</AsyncLogger>
<!-- Make extra sure nobody adds logs in a bad way that can hurt performance -->
<AsyncLogger name="org.apache.druid.client.ServerInventoryView" level="debug" additivity="false">
<AppenderRef ref="Console"/>
</AsyncLogger>
<AsyncLogger name ="org.apache.druid.java.util.http.client.pool.ChannelResourceFactory" level="info" additivity="false">
<AppenderRef ref="Console"/>
</AsyncLogger>
<Root level="info">
<AppenderRef ref="Console"/>
</Root>
</Loggers>
</Configuration>
```
365 changes: 365 additions & 0 deletions docs/content/operations/basic-cluster-tuning.md

Large diffs are not rendered by default.

49 changes: 49 additions & 0 deletions docs/content/operations/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
layout: doc_page
title: "Getting Started with Apache Druid (incubating)"
---

<!--
~ 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.
-->

# Getting Started with Apache Druid (incubating)

## Overview

If you are new to Druid, we recommend reading the [Design Overview](../design/index.html) and the [Ingestion Overview](../ingestion/index.html) first for a basic understanding of Druid.

## Single-server Quickstart and Tutorials

To get started with running Druid, the simplest and quickest way is to try the [single-server quickstart and tutorials](../tutorials/index.html).

## Deploying a Druid cluster

If you wish to jump straight to deploying Druid as a cluster, or if you have an existing single-server deployment that you wish to migrate to a clustered deployment, please see the [Clustered Deployment Guide](../tutorials/cluster.md).

## Operating Druid

The [Configuration Reference](../configuration/index.html) describes all of Druid's configuration properties.

The [API Reference](../operations/api-reference.html) describes the APIs available on each Druid process.

The [Basic Cluster Tuning Guide](../operations/basic-cluster-tuning.html) is an introductory guide for tuning your Druid cluster.

## Need help with Druid?

If you have questions about using Druid, please reach out to the [Druid user mailing list or other community channels](https://druid.apache.org/community/)!
95 changes: 0 additions & 95 deletions docs/content/operations/performance-faq.md

This file was deleted.

2 changes: 2 additions & 0 deletions docs/content/operations/single-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ The startup scripts for these example configurations run a single ZK instance al

The example configurations run the Druid Coordinator and Overlord together in a single process using the optional configuration `druid.coordinator.asOverlord.enabled=true`, described in the [Coordinator configuration documentation](../configuration/index.html#coordinator-operation).

While example configurations are provided for very large single machines, at higher scales we recommend running Druid in a [clustered deployment](../tutorials/cluster.md), for fault-tolerance and reduced resource contention.

## Single Server Reference Configurations

Micro-Quickstart: 4 CPU, 16GB RAM
Expand Down
37 changes: 20 additions & 17 deletions docs/content/toc.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,21 +30,22 @@ layout: toc
* [Query processing](/docs/VERSION/design/index.html#query-processing)
* [External dependencies](/docs/VERSION/design/index.html#external-dependencies)
* [Ingestion overview](/docs/VERSION/ingestion/index.html)
* [Quickstart](/docs/VERSION/tutorials/index.html)
* [Tutorial: Loading a file](/docs/VERSION/tutorials/tutorial-batch.html)
* [Tutorial: Loading stream data from Apache Kafka](/docs/VERSION/tutorials/tutorial-kafka.html)
* [Tutorial: Loading a file using Apache Hadoop](/docs/VERSION/tutorials/tutorial-batch-hadoop.html)
* [Tutorial: Loading stream data using HTTP push](/docs/VERSION/tutorials/tutorial-tranquility.html)
* [Tutorial: Querying data](/docs/VERSION/tutorials/tutorial-query.html)
* Further tutorials
* [Tutorial: Rollup](/docs/VERSION/tutorials/tutorial-rollup.html)
* [Tutorial: Configuring retention](/docs/VERSION/tutorials/tutorial-retention.html)
* [Tutorial: Updating existing data](/docs/VERSION/tutorials/tutorial-update-data.html)
* [Tutorial: Compacting segments](/docs/VERSION/tutorials/tutorial-compaction.html)
* [Tutorial: Deleting data](/docs/VERSION/tutorials/tutorial-delete-data.html)
* [Tutorial: Writing your own ingestion specs](/docs/VERSION/tutorials/tutorial-ingestion-spec.html)
* [Tutorial: Transforming input data](/docs/VERSION/tutorials/tutorial-transform-spec.html)
* [Clustering](/docs/VERSION/tutorials/cluster.html)
* [Getting Started](/docs/VERSION/operations/getting-started.html)
* [Single-server Quickstart](/docs/VERSION/tutorials/index.html)
* [Tutorial: Loading a file](/docs/VERSION/tutorials/tutorial-batch.html)
* [Tutorial: Loading stream data from Apache Kafka](/docs/VERSION/tutorials/tutorial-kafka.html)
* [Tutorial: Loading a file using Apache Hadoop](/docs/VERSION/tutorials/tutorial-batch-hadoop.html)
* [Tutorial: Loading stream data using HTTP push](/docs/VERSION/tutorials/tutorial-tranquility.html)
* [Tutorial: Querying data](/docs/VERSION/tutorials/tutorial-query.html)
* Further tutorials
* [Tutorial: Rollup](/docs/VERSION/tutorials/tutorial-rollup.html)
* [Tutorial: Configuring retention](/docs/VERSION/tutorials/tutorial-retention.html)
* [Tutorial: Updating existing data](/docs/VERSION/tutorials/tutorial-update-data.html)
* [Tutorial: Compacting segments](/docs/VERSION/tutorials/tutorial-compaction.html)
* [Tutorial: Deleting data](/docs/VERSION/tutorials/tutorial-delete-data.html)
* [Tutorial: Writing your own ingestion specs](/docs/VERSION/tutorials/tutorial-ingestion-spec.html)
* [Tutorial: Transforming input data](/docs/VERSION/tutorials/tutorial-transform-spec.html)
* [Clustering](/docs/VERSION/tutorials/cluster.html)

## Data Ingestion
* [Ingestion overview](/docs/VERSION/ingestion/index.html)
Expand Down Expand Up @@ -131,7 +132,6 @@ layout: toc
* [Updating the Cluster](/docs/VERSION/operations/rolling-updates.html)
* [Different Hadoop Versions](/docs/VERSION/operations/other-hadoop.html)
* [High Availability](/docs/VERSION/operations/high-availability.html)
* [Performance FAQ](/docs/VERSION/operations/performance-faq.html)
* [Management UIs](/docs/VERSION/operations/management-uis.html)
* [Dump Segment Tool](/docs/VERSION/operations/dump-segment.html)
* [Insert Segment Tool](/docs/VERSION/operations/insert-segment-to-db.html)
Expand All @@ -140,6 +140,9 @@ layout: toc
* [TLS Support](/docs/VERSION/operations/tls-support.html)
* [Password Provider](/docs/VERSION/operations/password-provider.html)
* [HTTP Compression](/docs/VERSION/operations/http-compression.html)
* [Basic Cluster Tuning](/docs/VERSION/operations/basic-cluster-tuning.html)
* [Single-server Deployment Examples](/docs/VERSION/operations/single-server.html)
* [Clustered Deployment Example](/docs/VERSION/operations/example-cluster.html)

## Configuration
* [Configuration Reference](/docs/VERSION/configuration/index.html)
Expand All @@ -154,7 +157,7 @@ layout: toc
* [Caching](/docs/VERSION/configuration/index.html#cache-configuration)
* [General Query Configuration](/docs/VERSION/configuration/index.html#general-query-configuration)
* [Configuring Logging](/docs/VERSION/configuration/logging.html)

## Development
* [Overview](/docs/VERSION/development/overview.html)
* [Libraries](/docs/VERSION/development/libraries.html)
Expand Down
Loading